Skip to content

Commit

Permalink
Simplify README
Browse files Browse the repository at this point in the history
  • Loading branch information
mezz committed Oct 26, 2016
1 parent f94b7d4 commit 1e01262
Showing 1 changed file with 7 additions and 24 deletions.
31 changes: 7 additions & 24 deletions README.md
@@ -1,17 +1,13 @@
[![Build Status](https://dvs1.progwml6.com/jenkins/job/JustEnoughItems/badge/icon)](https://dvs1.progwml6.com/jenkins/job/JustEnoughItems) [![](http://cf.way2muchnoise.eu/full_just-enough-items-jei_downloads.svg)](http://minecraft.curseforge.com/projects/just-enough-items-jei) [![](http://cf.way2muchnoise.eu/versions/Available%20For%20Minecraft_just-enough-items-jei_all.svg)](http://minecraft.curseforge.com/projects/just-enough-items-jei)
JustEnoughItems (JEI)

[JustEnoughItems (JEI)](http://minecraft.curseforge.com/projects/just-enough-items-jei/files)
===============
JustEnoughItems is an Item and Recipe viewing mod with a focus on stability, performance, and ease of use.

This means:
* not a coremod
* no dependencies other than Forge
* just items and recipes
* clean API for developers
* nothing but items and recipes

Download
===============
[Grab the latest versions from curseforge.](http://minecraft.curseforge.com/projects/just-enough-items-jei/files)
* not a coremod, no dependencies other than Forge

Developing Addons
===============
Expand All @@ -32,21 +28,11 @@ dependencies {
}
```

`${mcversion}` and `${jei_version}` can be found [here](http://dvs1.progwml6.com/files/maven/mezz/jei/) or on [CurseForge](http://minecraft.curseforge.com/projects/just-enough-items-jei/files), check the file name of the version you want.

Developer FAQ
===
Q: Why isn't my gradle working?
* A: Do not put the `repositories` section in your `buildscript` area. It should be its own section, outside of `buildscript`.
* A: See the build.gradle of any of the many mods that include JEI integration (listed in the "Plugin Examples" section below).

Q: Why aren't all of my items showing up in the item list? They are shown in the creative menu.
* A: JEI hides items with missing item models (purple and black). You can show them by changing the config option in the in-game config menu.
`${mcversion}` and `${jei_version}` can be found [here](http://dvs1.progwml6.com/files/maven/mezz/jei/) or on [CurseForge](http://minecraft.curseforge.com/projects/just-enough-items-jei/files), check the file name of the version you want.

Q: Where is the deobfuscated jar for developers?
* A: Use the regular jar file. Forge 1.8.9+ versions automatically deobfuscate jars in the /mods/ directory.
Note that the `repositories` section belongs outside the `buildscript` area.

Still have questions? Join [#JEI on esper.net IRC](http://webchat.esper.net/?nick=JEIGithub...&channels=JEI&prompt=1) for questions or anything else!
Have questions? Join [#JEI on esper.net IRC](http://webchat.esper.net/?nick=JEIGithub...&channels=JEI&prompt=1) for questions or anything else!

Plugin Examples (how to use the API)
===
Expand All @@ -55,13 +41,10 @@ Thankfully there are many working examples:
* [Vanilla Minecraft](https://github.com/mezz/JustEnoughItems/tree/1.10/src/main/java/mezz/jei/plugins/vanilla) (written as a plugin in JEI)
* [Blood Magic](https://github.com/WayofTime/BloodMagic/tree/1.9/src/main/java/WayofTime/bloodmagic/compat/jei)
* [Botania](https://github.com/Vazkii/Botania/tree/master/src/main/java/vazkii/botania/client/integration/jei)
* [Draconic Evolution](https://github.com/brandon3055/Draconic-Evolution/tree/1.9/src/main/java/com/brandon3055/draconicevolution/integration/jei)
* [EnderIO](https://github.com/SleepyTrousers/EnderIO/tree/1.10/src/main/java/crazypants/enderio/integration/jei)
* [Forestry (Apiculture)](https://github.com/ForestryMC/ForestryMC/blob/mc-1.10/src/main/java/forestry/apiculture/compat/ApicultureJeiPlugin.java)
* [Forestry (Machines)](https://github.com/ForestryMC/ForestryMC/tree/mc-1.10/src/main/java/forestry/factory/recipes/jei)
* [Immersive Engineering](https://github.com/BluSunrize/ImmersiveEngineering/tree/master/src/main/java/blusunrize/immersiveengineering/common/util/compat/jei)
* [Iron Backpacks](https://github.com/gr8pefish/IronBackpacks/tree/master-1.10/src/main/java/gr8pefish/ironbackpacks/integration/jei)
* [Mantle](https://github.com/SlimeKnights/Mantle/blob/master/src/main/java/slimeknights/mantle/util/JeiPlugin.java)
* [Refined Storage](https://github.com/raoulvdberge/refinedstorage/tree/mc1.10/src/main/java/refinedstorage/integration/jei)
* [RFTools](https://github.com/McJty/RFTools/tree/1.10/src/main/java/mcjty/rftools/jei)
* [Simple Covers](https://github.com/bdew/covers/tree/mc1.10.2/src/net/bdew/covers/compat/jei) (Scala)
Expand Down

0 comments on commit 1e01262

Please sign in to comment.