Initial project setup: RoadRunner (Multi-loader Stonecutter Template)
This commit is contained in:
24
README_SETUP.md
Normal file
24
README_SETUP.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# RoadRunner Setup Instructions
|
||||
|
||||
## Prerequisites
|
||||
1. **Java 21 JDK**: You must have Java 21 installed.
|
||||
- Verify with: `java -version`
|
||||
2. **IntelliJ IDEA**: Recommended IDE for Kotlin/Minecraft development.
|
||||
- Install the "Minecraft Development" plugin.
|
||||
|
||||
## Getting Started
|
||||
1. Open this folder in IntelliJ IDEA.
|
||||
2. Allow Gradle to sync. This might take a few minutes as it downloads Minecraft and dependencies.
|
||||
3. To run the mod:
|
||||
- Open the "Gradle" tab in IntelliJ.
|
||||
- Navigate to `RoadRunner -> Tasks -> architectury -> runClient`.
|
||||
- Or run in terminal: `./gradlew runClient`
|
||||
|
||||
## Project Structure
|
||||
- `src/main/kotlin`: Main mod logic (Common code)
|
||||
- `src/main/java`: Java sources (Mixins)
|
||||
- `versions/`: Loader-specific configurations (Fabric/NeoForge)
|
||||
- `PLAN.md`: Development roadmap
|
||||
|
||||
## Next Steps
|
||||
Check `PLAN.md` for the feature roadmap.
|
||||
Reference in New Issue
Block a user