| # Contributing to Climbing Holds 3D Database |
|
|
| Thank you for considering contributing to this community-driven dataset. Below are guidelines to keep the dataset consistent and easy to use with SetRsoft. |
|
|
| ## How to contribute |
|
|
| - **Add new holds** — contribute 3D models and metadata for climbing holds. |
| - **Improve existing entries** — fix metadata, update textures or models. |
| - **Documentation** — improve the README or this file. |
|
|
| ## Adding a new hold |
|
|
| ### 1. Directory structure |
|
|
| Create a folder named with the **hold ID** (e.g. `0000000002`) at the root of the dataset. |
|
|
| Include: |
|
|
| | File or folder | Description | |
| |-------------------|----------------------------------------------------------------------| |
| | `hold.glb` | Web-ready 3D model (or `.obj`, `.stl`) | |
| | `hold.blend` | Source file for Blender | |
| | `texture.png` | Texture image (PNG, JPG, TGA, BMP, WebP, etc.) | |
| | `images/` | Photos used for photogrammetry, reference images (e.g., dimensions) | |
| | `metadata.json` | Hold specifications (see below) | |
|
|
|
|
| ### 2. Naming and IDs |
|
|
| - Use a unique, zero-padded numeric ID for the folder (e.g. `0000000001`, `0000000002`). |
| - Coordinate with maintainers if you need a new ID to avoid conflicts. |
|
|
| ### 3. metadata.json |
|
|
| - Use **Unix timestamps** (seconds) for `created_at` and `last_update`. |
| - Set **timezone_offset** (e.g. `"+01:00"`, `"UTC"`) so dates can be interpreted correctly. |
| - Fill in as many fields as possible: `type`, `labels`, `color_of_scan`, `available_colors`, `manufacturer`, `model`, `size`, etc. |
| - **note** (optional): free-text notes or comments about the hold for contributors. |
| - **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). |
|
|
| Refer to the example in the [README](README.md#-structure). |
|
|
| ### 4. File formats |
|
|
| - **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. |
| - **Blend** — keep the source file so others can edit or re-export (optional). |
| - **Texture** — PNG, JPG, JPEG, TGA, BMP, WebP; avoid unnecessarily large resolutions. |
| - **images/** — place photos used for generation and reference images (e.g. dimensions) in this subfolder; any common image format. |
|
|
| ## Submitting changes |
|
|
| 1. **Fork** the repository and create a branch (e.g. `add-hold-0000000002`). |
| 2. **Add or modify** only the hold folder(s) and files you are contributing. |
| 3. **Open a Pull Request** with a short description of the hold(s) and, if applicable, source (scan, manufacturer, etc.). |
| 4. Maintainers will review structure, metadata, and file validity. |
|
|
| ## License and intellectual property |
|
|
| By contributing, you agree that your contributions are licensed under **CC-BY-SA-4.0**. |
|
|
| ## Questions |
|
|
| Open an [Issue](https://github.com/SetterSoft/huggingface-holds-dataset/issues) for questions, ID requests, or discussion. |
|
|
