Ansible Crafting — Documentation¶
Welcome to the Ansible Crafting developer and technical documentation. For the mod description and player-facing information, see the README.
📖 Documentation site: This documentation is automatically published to GitLab Pages on every push to
main. The site is read-only — all edits should be made in the repository.
Documentation Map¶
flowchart LR
README["📦 README.md<br/>Mod description"] --> INDEX["📚 docs/index.md<br/>You are here"]
CONTRIB["🤝 CONTRIBUTING.md"] --> INDEX
GUIDE["📏 GUIDELINES.md"] --> INDEX
INDEX --> DEV["🔨 Development"]
INDEX --> REL["🚀 Releasing"]
INDEX --> ARCH["🏗️ Architecture"]
INDEX --> CICD["⚙️ CI/CD"]
INDEX --> CONF["⚡ Configuration"]
INDEX --> SHADER["🌈 Shader Compatibility"]
INDEX --> DEBUG["🐛 Debug Logging"]Guides¶
| Document | Description |
|---|---|
| Development Guide | Setting up your dev environment, building, testing, Gradle tasks, multi-version support |
| Release Process | Release scripts (PowerShell & Bash), splash taglines, changelog generation with git-cliff |
| Architecture Overview | Package structure, key classes, data flows, Mermaid diagrams |
| CI/CD Pipeline | GitLab CI/CD stages, jobs, required variables, deployment |
| Configuration Reference | All mod config options with defaults, ranges, and descriptions |
| Shader Compatibility | How shader detection works, known compatible packs, troubleshooting |
| Debug Logging | Enabling debug output, Log4j2 configuration, what gets logged |
Project-Root Documents¶
| Document | Description |
|---|---|
| README | Player-facing mod description for Modrinth / CurseForge |
| Contributing | How to report bugs, suggest features, and submit merge requests |
| Development Guidelines | Code style, testing standards, Git practices, Minecraft mod conventions |
| Changelog | Auto-generated release history (git-cliff) |
| Security Policy | How to report vulnerabilities |
| Code of Conduct | Contributor Covenant v2.1 |
| License | Mozilla Public License 2.0 |