eberling1 commited on
Commit
c741861
Β·
1 Parent(s): 18bc835

Enhance CONTRIBUTING.md, README.md, and global_index.json with updated file requirements and status definitions. Added optional fields for notes and status in metadata, clarified accepted file formats, and included details on images for photogrammetry.

Browse files
Files changed (3) hide show
  1. CONTRIBUTING.md +14 -9
  2. README.md +19 -5
  3. global_index.json +6 -0
CONTRIBUTING.md CHANGED
@@ -16,12 +16,14 @@ Create a folder named with the **hold ID** (e.g. `0000000002`) at the root of th
16
 
17
  Include:
18
 
19
- | File | Description | Required |
20
- |----------------|--------------------------------------|----------|
21
- | `hold.glb` | Web-ready 3D model | Yes |
22
- | `hold.blend` | Source file for Blender | Yes |
23
- | `texture.png` | Texture image (PNG or JPG) | Optional |
24
- | `metadata.json`| Hold specifications (see below) | Yes |
 
 
25
 
26
  ### 2. Naming and IDs
27
 
@@ -33,14 +35,17 @@ Include:
33
  - Use **Unix timestamps** (seconds) for `created_at` and `last_update`.
34
  - Set **timezone_offset** (e.g. `"+01:00"`, `"UTC"`) so dates can be interpreted correctly.
35
  - Fill in as many fields as possible: `type`, `labels`, `color_of_scan`, `available_colors`, `manufacturer`, `model`, `size`, etc.
 
 
36
 
37
  Refer to the example in the [README](README.md#-structure).
38
 
39
  ### 4. File formats
40
 
41
- - **GLB** β€” standard for web and SetRsoft; export from Blender with scale and orientation consistent with existing holds.
42
- - **Blend** β€” keep the source file so others can edit or re-export.
43
- - **Texture** β€” PNG or JPG; avoid unnecessary large resolutions.
 
44
 
45
  ## Submitting changes
46
 
 
16
 
17
  Include:
18
 
19
+ | File or folder | Description |
20
+ |-------------------|----------------------------------------------------------------------|
21
+ | `hold.glb` | Web-ready 3D model (or `.obj`, `.stl`) |
22
+ | `hold.blend` | Source file for Blender |
23
+ | `texture.png` | Texture image (PNG, JPG, TGA, BMP, WebP, etc.) |
24
+ | `images/` | Photos used for photogrammetry, reference images (e.g., dimensions) |
25
+ | `metadata.json` | Hold specifications (see below) |
26
+
27
 
28
  ### 2. Naming and IDs
29
 
 
35
  - Use **Unix timestamps** (seconds) for `created_at` and `last_update`.
36
  - Set **timezone_offset** (e.g. `"+01:00"`, `"UTC"`) so dates can be interpreted correctly.
37
  - Fill in as many fields as possible: `type`, `labels`, `color_of_scan`, `available_colors`, `manufacturer`, `model`, `size`, etc.
38
+ - **note** (optional): free-text notes or comments about the hold for contributors.
39
+ - **status** (optional): workflow state β€” `to_render` (only photos, no mesh yet), `to_clean` (mesh present but not cleaned), `to_identify` (brand/model not in allowed references).
40
 
41
  Refer to the example in the [README](README.md#-structure).
42
 
43
  ### 4. File formats
44
 
45
+ - **3D mesh** β€” GLB, GLTF, OBJ, or STL; at least one required for a complete hold. GLB is standard for web and SetRsoft; export from Blender with scale and orientation consistent with existing holds.
46
+ - **Blend** β€” keep the source file so others can edit or re-export (optional).
47
+ - **Texture** β€” PNG, JPG, JPEG, TGA, BMP, WebP; avoid unnecessarily large resolutions.
48
+ - **images/** β€” place photos used for generation and reference images (e.g. dimensions) in this subfolder; any common image format.
49
 
50
  ## Submitting changes
51
 
README.md CHANGED
@@ -33,16 +33,26 @@ The dataset follows a strict directory-based structure to ensure portability and
33
  ```text
34
  data/
35
  β”œβ”€β”€ [hold_id]/
36
- β”œβ”€β”€β”€β”€ hold.glb # Web-ready 3D model
37
- β”œβ”€β”€β”€β”€ hold.blend # Source file for editing in Blender
38
- β”œβ”€β”€β”€β”€ texture.png
39
- └──── metadata.json # Hold specifications (brand, model, size, etc.)
 
 
40
  ```
41
 
 
 
 
 
 
 
42
  Example of metadata.json :
43
 
44
  Use **timestamps** (Unix epoch in seconds) for `created_at` and `last_update`, please specify the **timezone offset** `timezone_offset`).
45
 
 
 
46
  ```json
47
  {
48
  "id": 1,
@@ -56,10 +66,14 @@ Use **timestamps** (Unix epoch in seconds) for `created_at` and `last_update`, p
56
  "available_colors": ["#FF3200"],
57
  "manufacturer": "trikit",
58
  "model": "unknown",
59
- "size": "XL"
 
 
60
  }
61
  ```
62
 
 
 
63
  # βš–οΈ License & Intellectual Property
64
  Dataset License: CC-BY-SA-4.0.
65
 
 
33
  ```text
34
  data/
35
  β”œβ”€β”€ [hold_id]/
36
+ β”œβ”€β”€β”€β”€ hold.glb # Web-ready 3D model (or .obj, .stl)
37
+ β”œβ”€β”€β”€β”€ hold.blend # Source file for editing in Blender (optional)
38
+ β”œβ”€β”€β”€β”€ texture.png # Texture (PNG, JPG, etc.)
39
+ β”œβ”€β”€β”€β”€ images/ # Optional: photos for generation, reference images (e.g. dimensions)
40
+ β”œβ”€β”€β”€β”€ └── *.png, *.jpg, ...
41
+ └──── metadata.json # Hold specifications (brand, model, size, status, note, etc.)
42
  ```
43
 
44
+ **Accepted file formats in each hold directory:**
45
+
46
+ - **3D mesh:** `.glb`, `.gltf`, `.obj`, `.stl` (at least one required for a complete hold).
47
+ - **Textures:** `.png`, `.jpg`, `.jpeg`, `.tga`, `.bmp`, `.webp` (optional).
48
+ - **images/** subfolder: photos used for generation and reference images (e.g. dimensions); any common image format.
49
+
50
  Example of metadata.json :
51
 
52
  Use **timestamps** (Unix epoch in seconds) for `created_at` and `last_update`, please specify the **timezone offset** `timezone_offset`).
53
 
54
+ Optional fields: **note** (contributor notes or text about the hold), **status** (workflow state: `to_render`, `to_clean`, or `to_identify`).
55
+
56
  ```json
57
  {
58
  "id": 1,
 
66
  "available_colors": ["#FF3200"],
67
  "manufacturer": "trikit",
68
  "model": "unknown",
69
+ "size": "XL",
70
+ "note": "Optional notes about this hold.",
71
+ "status": "to_clean"
72
  }
73
  ```
74
 
75
+ **Status values:** `to_render` (only photos, no mesh yet), `to_clean` (GLB/Blend present but hold not cleaned), `to_identify` (brand or model not in allowed references).
76
+
77
  # βš–οΈ License & Intellectual Property
78
  Dataset License: CC-BY-SA-4.0.
79
 
global_index.json CHANGED
@@ -14,6 +14,11 @@
14
  "pinch",
15
  "volume",
16
  "unknown"
 
 
 
 
 
17
  ]
18
  },
19
  "stats": {
@@ -24,6 +29,7 @@
24
  "invalid_hold_type_reference": [],
25
  "invalid_manufacturer_reference": [],
26
  "invalid_metadata": [],
 
27
  "missing_mesh": [],
28
  "unknown_hold_type": [
29
  "0000000003",
 
14
  "pinch",
15
  "volume",
16
  "unknown"
17
+ ],
18
+ "status": [
19
+ "to_render",
20
+ "to_clean",
21
+ "to_identify"
22
  ]
23
  },
24
  "stats": {
 
29
  "invalid_hold_type_reference": [],
30
  "invalid_manufacturer_reference": [],
31
  "invalid_metadata": [],
32
+ "invalid_status_reference": [],
33
  "missing_mesh": [],
34
  "unknown_hold_type": [
35
  "0000000003",