Initialized basic structure
Browse files- .gitignore +29 -0
- 0000000001/.DS_Store +0 -0
- CONTRIBUTING.md +58 -0
.gitignore
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# OS
|
| 2 |
+
.DS_Store
|
| 3 |
+
Thumbs.db
|
| 4 |
+
|
| 5 |
+
# Editors / IDEs
|
| 6 |
+
.idea/
|
| 7 |
+
.vscode/
|
| 8 |
+
*.swp
|
| 9 |
+
*.swo
|
| 10 |
+
*~
|
| 11 |
+
|
| 12 |
+
# Python (if scripts are added later)
|
| 13 |
+
__pycache__/
|
| 14 |
+
.venv/
|
| 15 |
+
venv/
|
| 16 |
+
*.pyc
|
| 17 |
+
.pytest_cache/
|
| 18 |
+
|
| 19 |
+
# Blender backups
|
| 20 |
+
*.blend1
|
| 21 |
+
|
| 22 |
+
# Env and secrets
|
| 23 |
+
.env
|
| 24 |
+
.env.local
|
| 25 |
+
*.local
|
| 26 |
+
|
| 27 |
+
# Logs and temp
|
| 28 |
+
*.log
|
| 29 |
+
.cache/
|
0000000001/.DS_Store
DELETED
|
Binary file (6.15 kB)
|
|
|
CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Contributing to Climbing Holds 3D Database
|
| 2 |
+
|
| 3 |
+
Thank you for considering contributing to this community-driven dataset. Below are guidelines to keep the dataset consistent and easy to use with SetRsoft.
|
| 4 |
+
|
| 5 |
+
## How to contribute
|
| 6 |
+
|
| 7 |
+
- **Add new holds** — contribute 3D models and metadata for climbing holds.
|
| 8 |
+
- **Improve existing entries** — fix metadata, update textures or models.
|
| 9 |
+
- **Documentation** — improve the README or this file.
|
| 10 |
+
|
| 11 |
+
## Adding a new hold
|
| 12 |
+
|
| 13 |
+
### 1. Directory structure
|
| 14 |
+
|
| 15 |
+
Create a folder named with the **hold ID** (e.g. `0000000002`) at the root of the dataset.
|
| 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 |
+
|
| 28 |
+
- Use a unique, zero-padded numeric ID for the folder (e.g. `0000000001`, `0000000002`).
|
| 29 |
+
- Coordinate with maintainers if you need a new ID to avoid conflicts.
|
| 30 |
+
|
| 31 |
+
### 3. metadata.json
|
| 32 |
+
|
| 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 |
+
|
| 47 |
+
1. **Fork** the repository and create a branch (e.g. `add-hold-0000000002`).
|
| 48 |
+
2. **Add or modify** only the hold folder(s) and files you are contributing.
|
| 49 |
+
3. **Open a Pull Request** with a short description of the hold(s) and, if applicable, source (scan, manufacturer, etc.).
|
| 50 |
+
4. Maintainers will review structure, metadata, and file validity.
|
| 51 |
+
|
| 52 |
+
## License and intellectual property
|
| 53 |
+
|
| 54 |
+
By contributing, you agree that your contributions are licensed under **CC-BY-SA-4.0**.
|
| 55 |
+
|
| 56 |
+
## Questions
|
| 57 |
+
|
| 58 |
+
Open an [Issue](https://github.com/SetterSoft/huggingface-holds-dataset/issues) for questions, ID requests, or discussion.
|