Browse Source

Update README.md

Daniel She 6 years ago
parent
commit
4ae6322a11
1 changed files with 30 additions and 7 deletions
  1. 30 7
      README.md

+ 30 - 7
README.md

@@ -1,11 +1,34 @@
-# RoughlyEnoughItems
+# Roughly Enough Items
 https://minecraft.curseforge.com/projects/roughly-enough-items <br>
-This branch is a rewrite of REI
+Roughly Enough Items is a mod to view Items and Recipes for Minecraft 1.13 - 1.14, supporting mod loaders from Forge, Rift to Fabric.
+### Downloads
+[Detailed Downloads](https://gist.github.com/shedaniel/fc0742cf96dd4c4cf5d9653ba42ca2d0#roughly-enough-items)
 
-**Rewrite supports only 19w09a for now**
-![](https://media.discordapp.net/attachments/480755664675667980/528908880424730636/unknown.png?width=935&height=489)
+1.13's version requires [Rift](https://minecraft.curseforge.com/projects/rift).
+1.13.2's version requires [Chocohead's Rift Fork](https://github.com/Chocohead/Rift) or [Forge 1.13.2](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.13.2.html).
+1.14's version requires [Fabric Mod Loader](https://fabricmc.net/), [Cloth API](https://minecraft.curseforge.com/projects/cloth) and [Fabric API](https://minecraft.curseforge.com/projects/fabric). (Optional: [Plugin Loader](https://minecraft.curseforge.com/projects/pluginloader) for loading REI plugins)
 
-#### View [here](https://github.com/shedaniel/RoughlyEnoughItems/releases) for missing features
-#### Note that this is just a beta
+![](https://cdn.discordapp.com/attachments/472670263234920449/536198766118830081/unknown.png)
 
-You should not use this version unless you experience extreme bugs in the old version and you don't want the features above.
+This mod is completely client side. There is **impossible** to install this mod on a server.  
+However 1 feature will be disabled:
+- Item Deletion
+
+One feature will be limited:
+- Item Cheating (nbts are limited to 256 char = no long nbts)
+
+### Currently Supported Languages:
+- English
+- Chinese Traditional
+- Chinese Simplified
+- French
+- German
+- Estonian
+- LOLCATS
+- Upside Down English
+- Brazilian Portuguese
+
+### License
+Roughly Enough Items was a fork of Almost Enough Items by ZenDarva until v2.0 rewrite. This fork is permitted under the MIT license.  
+Roughly Enough Items is licensed under [MIT license](https://github.com/shedaniel/RoughlyEnoughItems/blob/1.14/LICENSE).  
+Cloth, which is Roughly Enough Items's depenency, is licensed under [The Unlicense](https://github.com/shedaniel/Cloth/blob/master/LICENSE).