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

More info for running, restarting and deploying

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

19
README.md
View File

@ -6,12 +6,15 @@
``` ```
# Mod Properties # Mod Properties
mod_version = 1.0.0 mod_version = 1.0.0
maven_group = net.fabricmc maven_group = com.myteam
archives_base_name = fabric-example-mod archives_base_name = mymod
``` ```
2. Run the following command to fetch Fabric dependencies: 2. Adjust the java classes structures and the resources resources json files 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.
3. Run the following command to fetch Fabric dependencies:
``` ```
./gradlew genSources ./gradlew genSources
``` ```
@ -22,6 +25,16 @@
- Visual Studio Code: see [Setting up Visual Studio Code with Fabric](https://fabricmc.net/wiki/setup:vscode) - 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) - Eclipse: see [Setting up Eclipse with Fabric](https://fabricmc.net/wiki/setup:eclipse)
## Running
You can simply run the Fabric server with your custom developed mod executing `./gradlew runServer`. (The first time you run this command you will need to accept the eula.txt inside the `/run` folder under the project root)
Sometimes the server daemon will get stuck and your server start can fail, to fix that run `./gradlew --stop`.
## Deploying
You can deploy your mod by running `./gradlew build` - then copy your jar file from the `build/lib` folder to your fabric server `mods` folder.
## License ## License
This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects. This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.