diff --git a/README.md b/README.md new file mode 100644 index 0000000000..be4ba6d248 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# NotEnoughUpdates +NotEnoughUpdates is a 1.8.9 forge mod that has been in development for about 11 months. +Starting as a simple recipe viewer, the mod has expanded to include a number of unique features for SkyBlock. + +## Major Features +- Skyblock Item List & Recipe Viewer +- Item Prices (Avg/Lowest BIN) +- QuickCommands™ +- Custom Auction House (/neuah) +- Item Collection Log (/neucl) +- Dungeon Chest Profit Checker +- Custom Enchant Colours +- Skyblock Profile Viewer +- Dungeon Mini Map +- Much more to come! + +## Configuration +To configure the mod, type ```/neuconfig``` ingame + +## Installation +First, head over to the [releases page](https://github.com/Moulberry/NotEnoughUpdates/releases) \ +then, download the .jar file into your ```.minecraft/mods``` folder + +## Discord Server +For New Release Info, Mod Updates, and a fun community! + +Join Here >> [Invite Link](https://discord.gg/spr6ESn) + +## Showcase Video +Watch it [here!](https://www.youtube.com/watch?v=Bz1O9aRPLOc) + +## Screenshots +![Sidebar Preview](readme_pictures/sidebar_preview.png?raw=true "Sidebar Preview") +![Custom Auction House](readme_pictures/custom_auction_house.png?raw=true "Custom Auction House") +![Item Collection Log](readme_pictures/item_collection_log.png?raw=true "Item Collection Log") +![Dungeon Profit Checker](readme_pictures/dungeon_profit_checker.png?raw=true "Dungeon Profit Checker") + +## Moulberry's Youtube +Youtube Channel Found [Here!](https://www.youtube.com/channel/UCPh-OKmRSS3IQi9p6YppLcw) + +## License +[Creative Commons License](https://creativecommons.org/licenses/by-nc/3.0/) \ No newline at end of file diff --git a/readme_pictures/custom_auction_house.png b/readme_pictures/custom_auction_house.png new file mode 100644 index 0000000000..171a1203b4 Binary files /dev/null and b/readme_pictures/custom_auction_house.png differ diff --git a/readme_pictures/dungeon_profit_checker.png b/readme_pictures/dungeon_profit_checker.png new file mode 100644 index 0000000000..4d02e487c2 Binary files /dev/null and b/readme_pictures/dungeon_profit_checker.png differ diff --git a/readme_pictures/item_collection_log.png b/readme_pictures/item_collection_log.png new file mode 100644 index 0000000000..0cad8b5b4e Binary files /dev/null and b/readme_pictures/item_collection_log.png differ diff --git a/readme_pictures/sidebar_preview.png b/readme_pictures/sidebar_preview.png new file mode 100644 index 0000000000..40bb72e90d Binary files /dev/null and b/readme_pictures/sidebar_preview.png differ