Steven/fabric-example-mod
1
0
Fork 0
Code Issues 38 Pull Requests 2 Projects Releases Wiki Activity

Update Example Mod Instructions

Browse Source
This commit is contained in:
Leo Ribeiro 2019-02-17 11:17:10 -05:00 committed by GitHub
parent b83fbda9e5
commit 7f186cd2c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -2,15 +2,26 @@
## Setup
1. Edit build.gradle and mod.json to suit your needs.
* The "mixins" object can be removed from mod.json if you do not need to use mixins.
* Please replace all occurences of "modid" with your own mod ID - sometimes, a different string may also suffice.
2. Run the following command:
1. Edit gradle.properties with the information of your mod.
```
# Mod Properties
mod_version = 1.0.0
maven_group = net.fabricmc
archives_base_name = fabric-example-mod
```
2. Run the following command to fetch Fabric dependencies:
```
./gradlew idea
./gradlew genSources
```
### Optional IDE Setup:
- IntelliJ IDEA: `./gradlew idea`
- Visual Studio Code: see [Setting up Visual Studio Code with Fabric](https://fabricmc.net/wiki/setup:vscode)
- Eclipse: see [Setting up Eclipse with Fabric](https://fabricmc.net/wiki/setup:eclipse)
## License
This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.