Cursor rule

1# Minecraft Fabric Mod Development Rules
2 
3## Project Context
4You are working on a Minecraft Fabric mod project with the following structure:
5- Fabric mod for Minecraft 1.21.5+
6- Uses Fabric Loader 0.16.14+ and Fabric API
7- Java 21 required
8- Gradle build system with Fabric Loom
9- CI/CD via GitHub Actions
10- Documentation site with Docusaurus
11 
12## Key Technologies
13- **Language**: Java 21
14- **Build Tool**: Gradle 8.12.1 with Fabric Loom
15- **Framework**: Fabric (Minecraft modding)
16- **Testing**: Minecraft test server via build.ps1
17- **Documentation**: Docusaurus (React/TypeScript)
18- **CI/CD**: GitHub Actions
19- **Publishing**: Modrinth, GitHub Releases
20 
21## Project Structure
22```
23mods-compostables/
24├── src/main/java/          # Java source code
25├── src/main/resources/     # Resources (mixins, fabric.mod.json)
26├── docs/                   # Documentation site (Docusaurus)
27├── scripts/                # Utility scripts
28├── gradle.properties       # Mod configuration
29└── build.gradle           # Build configuration
30```
31 
32## Namespace Convention
33- **Organization**: org.survivorsunited
34- **Mod ID**: Uses "su-" prefix (e.g., su-compostables)
35- **JAR Name**: Uses "su-" prefix
36- **Java Package**: org.survivorsunited.mods.{modname}
37- **Important**: "SU" prefix is ONLY for JAR names, Modrinth, and GitHub repos - NOT for internal code
38 
39## Configuration Management
40All mod properties are centralized in `gradle.properties`:
41- Minecraft/Fabric versions
42- Mod metadata (name, version, ID, etc.)
43- Dependencies
44- Use property expansion in fabric.mod.json and build.gradle
45 
46## Development Workflow
471. Make changes to Java code or resources
482. Run `.\build.ps1` to build
493. Run `.\build.ps1 -StartServer` to test with local server
504. Update documentation in `/docs` if needed
515. Commit changes (mod will be built by CI)
526. Tag releases for automatic publishing
53 
54## Build Scripts
55- **build.ps1**: Main build script
56  - Sets up Java 21 environment
57  - Builds mod
58  - Optionally starts test server with mod
59  - Downloads MC server & Fabric loader automatically
60  
61- **scripts/start-server.ps1**: Advanced server launcher
62  - Auto-detects Fabric server JAR
63  - Optimized JVM flags (8G-32G RAM)
64  - Automatic restart on crash
65 
66## CI/CD Pipeline
67GitHub Actions automatically:
681. Builds mod on every push/PR
692. Deploys documentation to GitHub Pages (main branch)
703. On release (tags):
71   - Creates GitHub release with changelog
72   - Updates Modrinth project description from docs/MODRINTH.md
73   - Publishes mod to Modrinth
74 
75## Documentation
76- **README.md**: Repository operations and development info
77- **docs/**: All gameplay and mod features documentation
78- **docs/MODRINTH.md**: Description for Modrinth project page
79 
80## Code Style
81- Follow Java conventions
82- Use meaningful variable names
83- Minimize comments (self-documenting code)
84- Use existing patterns in codebase
85- NEVER add comments unless explicitly requested
86 
87## Testing
88- Use local test server via build.ps1
89- Test both client and server functionality
90- Verify farmer villager interactions
91- Check all compostable items work correctly
92 
93## Common Tasks
94- **Add new compostable item**: Update Compostables.java and FarmerMixin.java if portable
95- **Change composting chance**: Modify value in registerCompostableItems()
96- **Update docs**: Edit files in /docs folder
97- **Release new version**: Update mod_version in gradle.properties, commit, tag, push
98 
99## Important Files
100- `gradle.properties`: Central configuration
101- `src/main/resources/fabric.mod.json`: Mod metadata (uses property expansion)
102- `src/main/java/.../Compostables.java`: Main mod class
103- `src/main/java/.../mixin/FarmerMixin.java`: Villager behavior
104- `docs/MODRINTH.md`: Modrinth project description