From 7f186cd2c74a9f7bc30b890f37020d3d82f22dc9 Mon Sep 17 00:00:00 2001 From: Leo Ribeiro Date: Sun, 17 Feb 2019 11:17:10 -0500 Subject: [PATCH] Update Example Mod Instructions --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 10fc90e..cead8ee 100644 --- a/README.md +++ b/README.md @@ -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.