From 374f3b22e8990173255705de4e6281d19750d165 Mon Sep 17 00:00:00 2001 From: Andrew Miner Date: Mon, 9 Feb 2015 13:29:53 -0800 Subject: [PATCH] Updated Adding support for a new Mod (markdown) --- Adding-support-for-a-new-Mod.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Adding-support-for-a-new-Mod.md b/Adding-support-for-a-new-Mod.md index b1cc0e4..db8fe55 100644 --- a/Adding-support-for-a-new-Mod.md +++ b/Adding-support-for-a-new-Mod.md @@ -1,14 +1,10 @@ Crafting Guide represents all its data in the form of simple configuration files and images. Anyone with a text editor can easily create everything needed to add a new mod. Here's a guide to how create everything from scratch. -## 1. Set up Minecraft - -The easiest way to access all the raw information is through the game itself. Start by installing both the mod you want to add and [NotEnoughItems](http://chickenbones.net/Pages/links.html) (along with its dependency, CodeChickenCore). Then, launch Minecraft, and create a new world for yourself. - -## 2. Fork the repo +## 1. Fork the repo Create a fork of this repo in which to make your changes. If you're not sure how to do this, check out GitHub's [help page](https://help.github.com/articles/fork-a-repo/) to get started. This will guide you through the process starting from the GitHub website all the way through having the code on your own computer. -## 3. Set up your environment +## 2. Set up your environment Crafting Guide comes with a number of different command-line scripts for processing data and testing. You'll need to get your machine set up with a few command-line tools to run them before you can begin. Start by downloading [Node.js](http://nodejs.org/download/) for your OS and installing it. Next, open a terminal and navigate to your new local repo. Run the following commands to get the rest of the tools you need and build everything locally. ```bash @@ -21,10 +17,14 @@ grunt clean build At this point, you have a local server running the CraftingGuide website running at [http://localhost:8000] (http://localhost:8000). As you work with your mod, you should verify your work on your local website. -## 4. 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//` 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 + +The easiest way to access all the raw information is through the game itself. Start by installing both the mod you want to add and [NotEnoughItems](http://chickenbones.net/Pages/links.html) (along with its dependency, CodeChickenCore). Then, launch Minecraft, and create a new world for yourself. + ## 5. Export the images When you pop open your inventory, you'll see the NotEnoughItems (NEI) interface. Click on "NEI Subsets", then "Mod", and finally, hold Shift and click the mod you want to work with. This will restrict the NEI display to only the items from that mod.