craftingguide/wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Adding support for a new Mod (markdown)

Browse Source
This commit is contained in:
Andrew Miner
2015-04-04 10:32:42 -07:00
parent ffe7f76278
commit 60e2fa798e
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Adding-support-for-a-new-Mod.md
+4 -4
View File
@@ -19,7 +19,7 @@ At this point, you have a local server running the CraftingGuide website running
## 3. Create a new directory ## 3. Create a new directory
Open up your clone of the Crafting Guide repository, and create a new directory: `./src/data/<mod_slug>/` where the `mod_slug` is the slug generated from the Mod's official name (see: [About Slugs](https://github.com/andrewminer/crafting-guide/wiki/About-Slugs)). Open up your clone of the Crafting Guide repository, and create a new directory: `./static/data/<mod_slug>/` where the `mod_slug` is the slug generated from the Mod's official name (see: [About Slugs](https://github.com/andrewminer/crafting-guide/wiki/About-Slugs)).
## 4. Set up Minecraft ## 4. Set up Minecraft
@@ -33,11 +33,11 @@ Next, you'll want to drill through the Options, Tools, and Data Dumps buttons.
Now, if you check your world's directory, you should see a `dumps/itempanel_icons` directory containing all the images for that mod's items. These will need to be renamed by converting each file name into the slug version. Now, if you check your world's directory, you should see a `dumps/itempanel_icons` directory containing all the images for that mod's items. These will need to be renamed by converting each file name into the slug version.
Next, run the `./scripts/convert-nei-dump <path to .../dumps> ./src/data/<mod>/<version>` command to convert the images into the format needed by Crafting Guide. This will also give you a starter data file for that mod version. Next, run the `./scripts/convert-nei-dump <path to .../dumps> <mod> <version>` command to convert the images into the format needed by Crafting Guide. This will also give you a starter data file for that mod version.
## 6. Create the data files ## 6. Create the data files
Create the mod's overall data file by following the [Mod Data Format](https://github.com/andrewminer/crafting-guide/wiki/Mod-Data-Format) guide to create the `./src/data/<mod>/mod.cg` file. Create the mod's overall data file by following the [Mod Data Format](https://github.com/andrewminer/crafting-guide/wiki/Mod-Data-Format) guide to create the `./static/data/<mod>/mod.cg` file.
Next is the hard part. From the last step, you should have a `mod-version.cg` in your Mod's current version directory. Now, for each item whose image you exported, follow the [Mod Version Data Format](https://github.com/andrewminer/crafting-guide/wiki/Mod-Version-Data-Format) reference to enter all the groups, items, recipes, and other information needed to describe your mod. Next is the hard part. From the last step, you should have a `mod-version.cg` in your Mod's current version directory. Now, for each item whose image you exported, follow the [Mod Version Data Format](https://github.com/andrewminer/crafting-guide/wiki/Mod-Version-Data-Format) reference to enter all the groups, items, recipes, and other information needed to describe your mod.
@@ -45,7 +45,7 @@ Be sure to test frequently using the `grunt test` command.
## 7. Test Locally ## 7. Test Locally
As you're going along, you may find it helpful to view your new mod in the website. To do so, first add your new file name to the `DefaultMods` list in `./src/scripts/constants.coffee`. It's often handy to open a second terminal window and run `grunt clean build watch` to continuously rebuild the website as you're working. Recall that you local server should still be running at [http://localhost:8000](http://localhost:8000). As you're going along, you may find it helpful to view your new mod in the website. To do so, first add your new file name to the `DefaultMods` list in `./src/coffee/constants.coffee`. It's often handy to open a second terminal window and run `grunt clean-watch` to continuously rebuild the website as you're working, but keep in mind that you'll need to restart the command if you happen to add a new file. Recall that you local server should still be running at [http://localhost:8000](http://localhost:8000).
Test by crafting the various items in your mod, and walking through the steps to ensure everything makes Test by crafting the various items in your mod, and walking through the steps to ensure everything makes
sense. In particular, you should look for: sense. In particular, you should look for: