From bd53070e4aa914992ac90d0dad90ac0a9e64e5b7 Mon Sep 17 00:00:00 2001 From: Andrew Miner Date: Tue, 3 Feb 2015 10:13:40 -0800 Subject: [PATCH] Updated Adding support for a new Mod (markdown) --- Adding-support-for-a-new-Mod.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/Adding-support-for-a-new-Mod.md b/Adding-support-for-a-new-Mod.md index 86bc16c..ccc1440 100644 --- a/Adding-support-for-a-new-Mod.md +++ b/Adding-support-for-a-new-Mod.md @@ -1,15 +1,5 @@ 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. -## 0. About Slugs - -This is a term which comes up a lot in Crafting Guide, so it's best to be clear about these up front. A slug is a version of a thing's name which has any troublesome characters removed, and which has been cleaned up for easy use in programs. These are generally created with the following steps: - -1. Replace any non-alphanumeric character with an `_` -2. Replace any duplicated `_` with a single one -3. Convert all letters to lowercase. - -In other words, you'd convert something like "Oak Wood Planks" to "oak_wood_planks" or "(Empty) Fuel Can" to "empty_fuel_can". - ## 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. @@ -20,7 +10,7 @@ Create a fork of this repo in which to make your changes. If you're not sure ho ## 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. +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)). ## 2. Export the images