From 920df0b967471f2d24bce825a831aec8e2452d9c Mon Sep 17 00:00:00 2001 From: copygirl Date: Sat, 13 Aug 2022 16:56:35 +0200 Subject: [PATCH] Edit README to link to wiki --- README.md | 85 +----------- docs/MODS.md | 342 ----------------------------------------------- docs/icon/cf.png | Bin 285 -> 0 bytes docs/icon/gh.png | Bin 552 -> 0 bytes docs/icon/mr.png | Bin 1240 -> 0 bytes 5 files changed, 4 insertions(+), 423 deletions(-) delete mode 100644 docs/MODS.md delete mode 100644 docs/icon/cf.png delete mode 100644 docs/icon/gh.png delete mode 100644 docs/icon/mr.png diff --git a/README.md b/README.md index be45bb4..e64bef8 100644 --- a/README.md +++ b/README.md @@ -4,84 +4,7 @@ *Heck* comes with a modest amount of configuration changes and [KubeJS](https://kubejs.com/) scripts that aim to make our mods work together well, fix minor issues, improve balance, change and add recipes, and most importantly unify most items and materials in the pack which would otherwise exist in multiple formats. We also have a couple of texture and localization changes to make things fit together well. -- For a **list of mods** including short descriptions, see [`docs/MODS.md`](docs/MODS.md). - - -## Download / Installation - -The modpack is currently only available as a **self-updating** PolyMC / MultiMC instance. - -- Download and install [PolyMC] (recommended) or [MultiMC], if you don't have it already. - These are third-party Minecraft launchers that simplify managing multiple instances of the game. -- Make sure you have **Java 17** (or higher) installed on your system. - You can check this by going to "Settings" in your launcher and go to "Java". - When you click "Auto-detect" and a version `17.x.x` appears, you can select it here. - If not, you can download the right [Eclipse Temurin](https://adoptium.net/temurin/releases/) version, and install it. - These are an alternative to the "official" Oracle Java releases, though I recommend them. -- To add *Heck* to the launcher, click "Add Instance", select "Import from zip", - and paste this: [`https://meowface.org/copygirl/Heck.zip`](https://meowface.org/copygirl/Heck.zip) -- On first launch, [packwiz] will download all mods and other modpack files. - On future launches, it will automatically check for updates and apply them. - -When updating the modpack, not all changes might be applied, because some settings are stored *per world*, which won't be overridden by the update process. If you're just playing multiplayer, this won't matter to you. If you're playing singleplayer however, you might want to copy the contents of the `defaultconfigs` folder into your world's `serverconfig` folder every now and then. - -[PolyMC]: https://polymc.org/ -[MultiMC]: https://multimc.org/ -[packwiz]: https://github.com/packwiz/packwiz - - -## Server Setup - -Grab the latest [packwiz bootstrapper](https://github.com/packwiz/packwiz-installer-bootstrap/releases) and [Forge installer](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.18.2.html) - the recommended version can be found in our [`pack.toml`](pack.toml). The entire installation process on the server side will look a little something like the following, assuming you have Java 17 ready and set up as the default. Otherwise just point any of the `java` commands to the correct executable. - -```sh -# Download the required bootstrapper and installer. -# Adjust if necessary, such as if a new version is available or required. -wget https://github.com/packwiz/packwiz-installer-bootstrap/releases/download/v0.0.3/packwiz-installer-bootstrap.jar -wget https://maven.minecraftforge.net/net/minecraftforge/forge/1.18.2-40.1.68/forge-1.18.2-40.1.68-installer.jar - -# Download modpack files. Also run this to update. -java -jar packwiz-installer-bootstrap.jar -g -s server https://meowface.org/copygirl/heck/pack.toml -# Changes made to files in `defaultconfigs` during updates are not applied to existing worlds. -# Therefore it is advised to copy them over by running the following command. -cp defaultconfigs/* $WORLD_LOCATION/serverconfig/ - -# Download Minecraft and Forge files. -java -jar forge-1.18.2-40.1.68-installer.jar --installServer - -# Now do the usual, accept the EULA, edit your server -# properties, run your startup script as you're used to. -java -jar -Xmx6G -Xms6G forge-1.18.2-40.1.68.jar nogui -``` - - -## Development - -Working on the modpack requires the [packwiz] tool, so be sure to download it first. - -```sh -packwiz update --all # Update all mods to latest. -git commit [...] # Now you can commit your changes.. -git push # ..and push them to the repository. -``` - -It should be noted that packwiz will keep an `index.toml` file and update `pack.toml` to keep track of it, mirroring any changes. However, since these changes are basically build artifacts, we decided to not include them in the repository. - -```sh -# Make sure git will not see any changes to pack.toml. -# This is to avoid accidentally committing the [index] section. -git update-index --assume-unchanged pack.toml -``` - -To test changes tocally, you can run `packwiz serve` to deploy a simple webserver that just hosts the modpack files. Setting your instance's pre-launch command to the following command will allow it to update from local files when starting up. - -```sh -"$INST_JAVA" -jar packwiz-installer-bootstrap.jar http//localhost:8080/pack.toml -``` - -While the game is running, you can use `rsync` to synchronize the `kubejs/` folder after making changes. This allows you to make, for example, recipe changes and test them out in-game, without restarting, simply by running the `/reload` command. - -```sh -# Just replace $PATH_TO_INSTANCE with your instance's location. -rsync -r --delete kubejs $PATH_TO_INSTANCE/.minecraft -``` +- For a **list of mods** including short descriptions, see the [Mod List](https://git.mcft.net/copygirl/heck/wiki/Mod-List). +- For instructions on how to **set up the modpack**, see [Download & Installation](https://git.mcft.net/copygirl/heck/wiki/Download-&-Installation). +- If you want to set up and run your own **server**, see [Server Setup](https://git.mcft.net/copygirl/heck/wiki/Server-Setup). +- For a quick overview on how to **contribute**, see [Development](https://git.mcft.net/copygirl/heck/wiki/Development). diff --git a/docs/MODS.md b/docs/MODS.md deleted file mode 100644 index 354233d..0000000 --- a/docs/MODS.md +++ /dev/null @@ -1,342 +0,0 @@ -## Common Mods - -### Optimization / Fixes - -- ![](icon/cf.png) [AI Improvements] - Optimizations related to mob AI -- ![](icon/mr.png) [Alternate Current] - Redstone re-implementation that improves performance -- ![](icon/cf.png) [Clumps] - Experience orbs merge to reduce lag and pickup time -- ![](icon/cf.png) [FastSuite] - Improves recipe performance -- ![](icon/mr.png) [Feature NBT Deadlock Be Gone] - Fixes freeze during worlgen -- ![](icon/mr.png) [FerriteCore] - Reduces memory usage -- ![](icon/cf.png) [LazyDFU] - Delays initialization of DataFixerUpper until needed -- ![](icon/cf.png) [Radium Reforged] - Various optimizations -- ![](icon/mr.png) [Spark] - Performance profiler - -[AI Improvements]: https://www.curseforge.com/minecraft/mc-mods/ai-improvements -[Alternate Current]: https://modrinth.com/mod/alternate-current -[Clumps]: https://www.curseforge.com/minecraft/mc-mods/clumps -[FastSuite]: https://www.curseforge.com/minecraft/mc-mods/fastsuite -[Feature NBT Deadlock Be Gone]: https://modrinth.com/mod/feature-nbt-deadlock-be-gone -[FerriteCore]: https://modrinth.com/mod/ferrite-core -[LazyDFU]: https://www.curseforge.com/minecraft/mc-mods/lazy-dfu-forge -[Radium Reforged]: https://www.curseforge.com/minecraft/mc-mods/radium-reforged -[Spark]: https://modrinth.com/mod/spark - -### Utility / Tweaks - -- ![](icon/cf.png) [Carry On] - Allows picking up blocks (like chests) and entities to relocate them -- ![](icon/cf.png) [Global GameRules] - Global gamerules that are applied on world load -- ![](icon/cf.png) [GoProne] - Allows going prone / crawling using a keybind (default: `C`) -- ![](icon/mr.png) [KubeJS] - Programmatically adjust things (such as recipes) using JavaScript - - ![](icon/cf.png) [KubeJS Botania](https://www.curseforge.com/minecraft/mc-mods/kubejs-botania) - - ![](icon/cf.png) [KubeJS Create](https://www.curseforge.com/minecraft/mc-mods/kubejs-create) - - ![](icon/cf.png) [KubeJS Immersive Engineering](https://www.curseforge.com/minecraft/mc-mods/kubejs-immersive-engineering) - - ![](icon/cf.png) [KubeJS Thermal](https://www.curseforge.com/minecraft/mc-mods/kubejs-thermal) - - ![](icon/mr.png) [LootJS](https://modrinth.com/mod/lootjs) -- ![](icon/cf.png) [Multi Mine] - Block mining progress persists and can be shared between players -- ![](icon/mr.png) [Simple Voice Chat] - Proximity voice chat with many features -- ![](icon/cf.png) [Universal Bone Meal] - Bonemeal works on additional blocks - -[Carry On]: https://www.curseforge.com/minecraft/mc-mods/carry-on -[Global GameRules]: https://www.curseforge.com/minecraft/mc-mods/global-gamerules -[GoProne]: https://www.curseforge.com/minecraft/mc-mods/goprone -[KubeJS]: https://modrinth.com/mod/kubejs -[Multi Mine]: https://www.curseforge.com/minecraft/mc-mods/multi-mine -[Simple Voice Chat]: https://modrinth.com/mod/simple-voice-chat -[Universal Bone Meal]: https://www.curseforge.com/minecraft/mc-mods/universal-bone-meal-forge - -### Balance / Combat - -- ![](icon/mr.png) [OverpoweredMending] - Mending is applied to most damaged tool in inventory first -- ![](icon/mr.png) [Tax Free Levels] - Fixes experience costs to not punish you when having more levels - -[OverpoweredMending]: https://modrinth.com/mod/overpoweredmending -[Tax Free Levels]: https://modrinth.com/mod/tax-free-levels - -### Various Content - -- ![](icon/cf.png) [Comforts] - Sleeping bags that don't set your spawn and hammocks that skip day -- ![](icon/cf.png) [Compost Bag] - Stores bonemeal, composts items, and can apply bonemeal in-world -- ![](icon/mr.png) [Eccentric Tome] - Book for storing other guide books -- ![](icon/cf.png) [Farmer's Delight] - More crops, cooking utensils, food and meals with effects - - ![](icon/cf.png) [Copper's Delight] - Adds a copper knife - - ![](icon/cf.png) [Corn Delight] - Adds corn crop with extra food items - - ![](icon/cf.png) [Farmer's Respite] - Adds brewing mechanics as well as tea - - ![](icon/cf.png) [Steel's Delight] - Adds a steel knife - - ![](icon/mr.png) [Twilight Delight] - Knives from Twilight Forest's materials and more meals -- ![](icon/cf.png) [Storage Drawers] - Compact and aesthetic storage solution - - ![](icon/cf.png) [Drawers Tooltip] - Shows what's contained in a drawer after picking it up -- ![](icon/mr.png) [TorchMaster] - Blocks that control mob spawning -- ![](icon/cf.png) [Quark] - Various content and gameplay improvements - - ![](icon/cf.png) [Quark Oddities] - Item pipes and totem of holding (captures items on death) - - ![](icon/cf.png) [Curious Quark Oddities Backpack] - Quark backpacks equippable in back slot -- ![](icon/cf.png) [Supplementaries] - Various content and decoration -- ![](icon/cf.png) [Time in a bottle standalone] - Accumulate time, then use it to speed up blocks - -[Comforts]: https://www.curseforge.com/minecraft/mc-mods/comforts -[Compost Bag]: https://www.curseforge.com/minecraft/mc-mods/compost-bag -[Eccentric Tome]: https://modrinth.com/mod/eccentric-tome -[Farmer's Delight]: https://www.curseforge.com/minecraft/mc-mods/farmers-delight -[Copper's Delight]: https://www.curseforge.com/minecraft/mc-mods/coppers-delight -[Corn Delight]: https://www.curseforge.com/minecraft/mc-mods/corn-delight -[Farmer's Respite]: https://www.curseforge.com/minecraft/mc-mods/farmers-respite -[Steel's Delight]: https://www.curseforge.com/minecraft/mc-mods/steels-delight -[Twilight Delight]: https://modrinth.com/mod/twilightdelight -[Storage Drawers]: https://www.curseforge.com/minecraft/mc-mods/storage-drawers -[TorchMaster]: https://modrinth.com/mod/torchmaster -[Drawers Tooltip]: https://www.curseforge.com/minecraft/mc-mods/drawers-tooltip -[Quark]: https://www.curseforge.com/minecraft/mc-mods/quark -[Quark Oddities]: https://www.curseforge.com/minecraft/mc-mods/quark-oddities -[Curious Quark Oddities Backpack]: https://www.curseforge.com/minecraft/mc-mods/curios-quark-oddities-backpack -[Supplementaries]: https://www.curseforge.com/minecraft/mc-mods/supplementaries -[Time in a bottle standalone]: https://www.curseforge.com/minecraft/mc-mods/time-in-a-bottle-standalone - -### Decoration - -- ![](icon/mr.png) [Adorn] - Decorative furniture blocks -- ![](icon/cf.png) [Bedspreads] - Apply banners to beds -- ![](icon/cf.png) [Cooking for Blockheads] - Kitchen related storage blocks and quick food crafting -- ![](icon/cf.png) [Decorative Blocks] - Various different decorative building blocks -- ![](icon/cf.png) [Every Compat] - Craft certain modded blocks from additional modded materials - -[Adorn]: https://modrinth.com/mod/adorn -[Bedspreads]: https://www.curseforge.com/minecraft/mc-mods/bedspreads -[Cooking for Blockheads]: https://www.curseforge.com/minecraft/mc-mods/cooking-for-blockheads -[Decorative Blocks]: https://www.curseforge.com/minecraft/mc-mods/decorative-blocks -[Every Compat]: https://www.curseforge.com/minecraft/mc-mods/every-compat - -### Equipment - -- ![](icon/cf.png) [Air Hop] - Boots enchantment for additional mid-air jumps -- ![](icon/mr.png) [Archer's Paradox] - Various new arrows with different effects -- ![](icon/cf.png) [Artifacts] - Rare equippable items with unique effects -- ![](icon/cf.png) [Backpacked] - Customizable, enchantable backpacks for carrying more items -- ![](icon/cf.png) [Cosmetic Armor Reworked] - Wear a different set of armor that's purely cosmetic -- ![](icon/cf.png) [Curio of Undying] - Equip totem of undying in your charm slot -- ![](icon/cf.png) [Curious Elytra] - Equip elytra in your back slot -- ![](icon/mr.png) [Ensorcellation] - Various additional enchantments -- ![](icon/mr.png) [Grappling Hook Mod] - Different grappling hooks, upgrades, and enchantments -- ![](icon/cf.png) [MrCrayfish's Gun Mod] - Unique, customizable and enchantable weapons -- ![](icon/mr.png) [Slimy Stuff] - More uses for slime such as tools and armor -- ![](icon/cf.png) [Tetra] - Craft modular weapons and tools, then improve them with use - - ![](icon/cf.png) [Tetra Pak] - Makes more materials compatible with Tetra -- ![](icon/cf.png) [Tinkers' Construct] - Customizable tools, smeltery and unique items -- ![](icon/mr.png) [Tool's Complement] - More tool types and tools made from more materials - -[Air Hop]: https://www.curseforge.com/minecraft/mc-mods/air-hop -[Archer's Paradox]: https://modrinth.com/mod/archers-paradox -[Artifacts]: https://www.curseforge.com/minecraft/mc-mods/artifacts -[Backpacked]: https://www.curseforge.com/minecraft/mc-mods/backpacked -[Cosmetic Armor Reworked]: https://www.curseforge.com/minecraft/mc-mods/cosmetic-armor-reworked -[Curio of Undying]: https://www.curseforge.com/minecraft/mc-mods/curio-of-undying -[Curious Elytra]: https://www.curseforge.com/minecraft/mc-mods/curious-elytra -[Ensorcellation]: https://modrinth.com/mod/ensorcellation -[Grappling Hook Mod]: https://modrinth.com/mod/grappling-hook-mod -[MrCrayfish's Gun Mod]: https://www.curseforge.com/minecraft/mc-mods/mrcrayfishs-gun-mod -[Slimy Stuff]: https://modrinth.com/mod/slimy-stuff -[Tetra]: https://www.curseforge.com/minecraft/mc-mods/tetra -[Tetra Pak]: https://www.curseforge.com/minecraft/mc-mods/tetra-pak -[Tinkers' Construct]: https://www.curseforge.com/minecraft/mc-mods/tinkers-construct -[Tool's Complement]: https://modrinth.com/mod/tools-complement - -### Mobs - -- ![](icon/cf.png) [Alex's Mobs] - Adds lots of mobs, both real and fictional -- ![](icon/mr.png) [Chicken Drop Feathers] - Adult chickens drop feathers from time to time -- ![](icon/cf.png) [Creeper Overhaul] - Unique creepers for different biomes -- ![](icon/cf.png) [Domestication Innovation] - Pet related items and enchantments -- ![](icon/cf.png) [Guard Villagers] - Villages have guards and other defense improving changes -- ![](icon/mr.png) [More Axolotl Variants Mod] - More flavors of axolotls, some gotten through breeding -- ![](icon/cf.png) [More MobGriefing Options] - Allows configuring `mobGriefing` per entity -- ![](icon/cf.png) [Untamed Wilds] - Expands on exploration with high-quality mobs and world generation -- ![](icon/cf.png) [Villager Names] - Gives villagers random names - -[Alex's Mobs]: https://www.curseforge.com/minecraft/mc-mods/alexs-mobs -[Chicken Drop Feathers]: https://modrinth.com/mod/chicken-drop-feathers -[Creeper Overhaul]: https://www.curseforge.com/minecraft/mc-mods/creeper-overhaul -[Domestication Innovation]: https://www.curseforge.com/minecraft/mc-mods/domestication-innovation -[Guard Villagers]: https://www.curseforge.com/minecraft/mc-mods/guard-villagers -[More Axolotl Variants Mod]: https://modrinth.com/mod/mavm -[More MobGriefing Options]: https://www.curseforge.com/minecraft/mc-mods/more-mobgriefing-options -[Passive Endermen]: https://www.curseforge.com/minecraft/mc-mods/passive-endermen -[Untamed Wilds]: https://www.curseforge.com/minecraft/mc-mods/untamedwilds -[Villager Names]: https://www.curseforge.com/minecraft/mc-mods/villager-names - -### Technology - -- ![](icon/mr.png) [Applied Energistics 2] - Digital item and fluid storage, auto-crafting and more - - ![](icon/cf.png) [Applied Botanics Addon] - Store mana digitally in Applied Energistics 2 -- ![](icon/mr.png) [Create] - Tools and blocks for building, decoration and aesthetic automation - - ![](icon/cf.png) [Create Chunkloading] - Chunkloader that works on moving Create contraptions - - ![](icon/cf.png) [Create Confectionery] - More Create style food items - - ![](icon/cf.png) [Create Stuff Additions] - Tools, armor and utility items from Create materials -- ![](icon/mr.png) [Immersive Engineering] - Electricity based technology mod with nice aesthetics -- ![](icon/mr.png) [Little Logistics] - Tugboats that can follow specific paths, move items and more - - ![](icon/cf.png) [Little Contraptions] - Create contraption support for Little Logistics -- ![](icon/mr.png) [Thermal Expansion] - Dynamos and machines to process materials - - ![](icon/mr.png) [Thermal Foundation] - Adds base materials and various items for the Thermal Series mods - - ![](icon/mr.png) [Thermal Innovation] - Adds upgradable, powered tools - - ![](icon/mr.png) [Thermal Integration] - Integration with other mods -- ![](icon/mr.png) [TIS-3D] - Program computer modules in ASM - -[Applied Energistics 2]: https://modrinth.com/mod/ae2 -[Applied Botanics Addon]: https://www.curseforge.com/minecraft/mc-mods/applied-botanics-addon -[Create]: https://modrinth.com/mod/create -[Create Chunkloading]: https://www.curseforge.com/minecraft/mc-mods/create-chunkloading -[Create Confectionery]: https://www.curseforge.com/minecraft/mc-mods/create-confectionery -[Create Stuff Additions]: https://www.curseforge.com/minecraft/mc-mods/create-stuff-additions -[Immersive Engineering]: https://modrinth.com/mod/immersiveengineering -[Little Logistics]: https://modrinth.com/mod/little-logistics -[Little Contraptions]: https://www.curseforge.com/minecraft/mc-mods/little-contraptions -[Thermal Expansion]: https://modrinth.com/mod/thermal-expansion -[Thermal Foundation]: https://modrinth.com/mod/thermal-foundation -[Thermal Innovation]: https://modrinth.com/mod/thermal-innovation -[Thermal Integration]: https://modrinth.com/mod/thermal-integration -[TIS-3D]: https://modrinth.com/mod/tis3d - -### Magic - -- ![](icon/cf.png) [Ars Nouveau] - Craft custom spells and create magical artifacts - - ![](icon/cf.png) [Ars Arsenal] - Elemental robes and source steel armor - - ![](icon/cf.png) [Ars Creo] - Allows casting spells from Create contraptions - - ![](icon/cf.png) [Ars Elemental] - Additions glyphs, tweaks, equipment and mobs - - ![](icon/cf.png) [Ars Instrumentum] - More items and other utility functions - - ![](icon/cf.png) [Too Many Glyphs] - Adds additional spell glyphs -- ![](icon/cf.png) [Botania] - Tech and automation disguised as flowery magic mod, with lots of toys -- ![](icon/cf.png) [Malum] - Dark magic mod centered around spirit magics -- ![](icon/cf.png) [Reliquary Reincarnations] - Magical relics crafted from rare mob drops - -[Ars Nouveau]: https://www.curseforge.com/minecraft/mc-mods/ars-nouveau -[Ars Arsenal]: https://www.curseforge.com/minecraft/mc-mods/ars-arsenal -[Ars Creo]: https://www.curseforge.com/minecraft/mc-mods/ars-creo -[Ars Elemental]: https://www.curseforge.com/minecraft/mc-mods/ars-elemental-elemental-spell-foci -[Ars Instrumentum]: https://www.curseforge.com/minecraft/mc-mods/ars-instrumentum -[Too Many Glyphs]: https://www.curseforge.com/minecraft/mc-mods/too-many-glyphs -[Botania]: https://www.curseforge.com/minecraft/mc-mods/botania -[Malum]: https://www.curseforge.com/minecraft/mc-mods/malum -[Reliquary Reincarnations]: https://www.curseforge.com/minecraft/mc-mods/reliquary-v1.3 - -### World Generation - -- ![](icon/cf.png) [Awesome Dungeon] - Unique dungeons to explore, conquer and loot - - ![](icon/cf.png) [Awesome Dungeon - Ocean Edition](https://www.curseforge.com/minecraft/mc-mods/awesome-dungeon-edition-ocean-forge) - - ![](icon/cf.png) [Awesome Dungeon - Nether Edition](https://www.curseforge.com/minecraft/mc-mods/awesome-dungeon-nether-forge) - - ![](icon/cf.png) [Awesome Dungeon - The End Edition](https://www.curseforge.com/minecraft/mc-mods/awesome-dungeon-the-end-forge) -- ![](icon/cf.png) [Biomes O' Plenty] - Expansive biome mod to add variety to the overworld and nether - - ![](icon/mr.png) [Compat O' Plenty] - Adds variants of various modded blocks made from BoP materials -- ![](icon/cf.png) [Chunk-Pregenerator] - Pregenerates the world to avoid worldgen lag -- ![](icon/cf.png) [Dungeon Crawl] - Tiered dungeons with loot that gets more difficult the deeper you go -- ![](icon/cf.png) [Dungeons Enhanced] - Many new structures and dungeons to explore -- ![](icon/cf.png) [Enlightened End] - Adds much needed content to the end -- ![](icon/mr.png) [Integrated Dungeons and Structures] - Structures that use other mods' content -- ![](icon/cf.png) [Lootr] - Per-player instanced loot chests -- ![](icon/mr.png) [Repurposed Structures] - Vanilla structures, repurposed for other biomes -- ![](icon/mr.png) [Stalwart Dungeons] - Special nether and end dungeons with unique loot -- ![](icon/cf.png) [Terralith] - Overhauls world generation, new and improved Vanilla biomes -- ![](icon/cf.png) [The Twilight Forest] - A whole magical dimension to explore and progress within -- ![](icon/cf.png) [When Dungeons Arise] - Massive, unique and potentially dangerous dungeons -- YUNG's Mods - Improved and additional structures - - ![](icon/cf.png) [YUNG's Better Desert Temples](https://www.curseforge.com/minecraft/mc-mods/yungs-better-desert-temples) - - ![](icon/cf.png) [YUNG's Better Dungeons](https://www.curseforge.com/minecraft/mc-mods/yungs-better-dungeons) - - ![](icon/cf.png) [YUNG's Better Mineshafts](https://www.curseforge.com/minecraft/mc-mods/yungs-better-mineshafts) - - ![](icon/cf.png) [YUNG's Better Strongholds](https://www.curseforge.com/minecraft/mc-mods/yungs-better-strongholds) - - ![](icon/cf.png) [YUNG's Better Witch Huts](https://www.curseforge.com/minecraft/mc-mods/yungs-better-witch-huts) - - ![](icon/cf.png) [YUNG's Extras](https://www.curseforge.com/minecraft/mc-mods/yungs-extras) - -[Awesome Dungeon]: https://www.curseforge.com/minecraft/mc-mods/awesome-dungeon-forge -[Biomes O' Plenty]: https://www.curseforge.com/minecraft/mc-mods/biomes-o-plenty -[Compat O' Plenty]: https://modrinth.com/mod/compatoplenty -[Chunk-Pregenerator]: https://www.curseforge.com/minecraft/mc-mods/chunkpregenerator -[Dungeon Crawl]: https://www.curseforge.com/minecraft/mc-mods/dungeon-crawl -[Dungeons Enhanced]: https://www.curseforge.com/minecraft/mc-mods/dungeonsenhanced -[Enlightened End]: https://www.curseforge.com/minecraft/mc-mods/enlightened-end -[Integrated Dungeons and Structures]: https://modrinth.com/mod/idas -[Lootr]: https://www.curseforge.com/minecraft/mc-mods/lootr -[Repurposed Structures]: https://modrinth.com/mod/repurposed-structures-forge -[Stalwart Dungeons]: https://modrinth.com/mod/stalwart-dungeons -[Terralith]: https://www.curseforge.com/minecraft/mc-mods/terralith -[The Twilight Forest]: https://www.curseforge.com/minecraft/mc-mods/the-twilight-forest -[When Dungeons Arise]: https://modrinth.com/mod/when-dungeons-arise - - -## Client-side Mods - -### Essential - -- ![](icon/cf.png) [Configured] - Improved configuration menu -- ![](icon/cf.png) [Controlling] - Improved controls menu -- ![](icon/cf.png) [Just Enough Items] - Look up recipes and uses for items - -[Configured]: https://www.curseforge.com/minecraft/mc-mods/configured -[Controlling]: https://www.curseforge.com/minecraft/mc-mods/controlling -[Just Enough Items]: https://www.curseforge.com/minecraft/mc-mods/jei - -### Optimization / Fixes - -- ![](icon/mr.png) [Rubidium] *(recommended)* - Graphical performance improvements -- ![](icon/mr.png) [Starlight] - Rewritten lighting engine for improved performance - -[Rubidium]: https://modrinth.com/mod/rubidium -[Starlight]: https://modrinth.com/mod/starlight-forge - -### Utility - -- ![](icon/cf.png) [Better Mods Button] - Better location for the "mods" button -- ![](icon/cf.png) [Catalogue] - Improved, prettier mod list -- ![](icon/cf.png) [Inventory Essentials] - Simple ways to move single / all items around -- ![](icon/cf.png) [Inventory Hotswap] - Switch out hotbar items for another from your inventory quickly -- ![](icon/mr.png) [JEI Integration] - Shows additional information in item tooltip (durability, enchantability) - -[Better Mods Button]: https://www.curseforge.com/minecraft/mc-mods/better-mods-button -[Catalogue]: https://www.curseforge.com/minecraft/mc-mods/catalogue -[Inventory Essentials]: https://www.curseforge.com/minecraft/mc-mods/inventory-essentials -[Inventory Hotswap]: https://www.curseforge.com/minecraft/mc-mods/inventory-hotswap -[JEI Integration]: https://modrinth.com/mod/jei-integration - -### Information - -- ![](icon/mr.png) [AppleSkin] - Display nutrition information of foods and player's hunger -- ![](icon/mr.png) [Better Recipe Book] - Usability improvements to the Vanilla recipe book -- ![](icon/cf.png) [Chat Heads] - Display player heads next to players' chat messages -- ![](icon/mr.png) [Detail Armor Bar] - Display more information about equipped armor in armor bar -- ![](icon/cf.png) [Jade] - Display information about blocks / entities looked add - - ![](icon/cf.png) [Jade Addons] - More mod support for Jade -- ![](icon/mr.png) [Light Overlay] - Toggle display for hostile mob spawns (default: `F7`) -- ![](icon/cf.png) [Toast Control] - Disables all tutorial and advancement toasts -- ![](icon/cf.png) [Xaero's Minimap] - Display minimap and supports creating waypoints -- ![](icon/cf.png) [Xaero's World Map] - Stores and display a map of the whole world - -[AppleSkin]: https://modrinth.com/mod/appleskin -[Better Recipe Book]: https://modrinth.com/mod/brb -[Chat Heads]: https://www.curseforge.com/minecraft/mc-mods/chat-heads -[Detail Armor Bar]: https://modrinth.com/mod/detail-armor-bar -[Jade]: https://www.curseforge.com/minecraft/mc-mods/jade -[Jade Addons]: https://www.curseforge.com/minecraft/mc-mods/jade-addons -[Light Overlay]: https://modrinth.com/mod/light-overlay -[Toast Control]: https://www.curseforge.com/minecraft/mc-mods/toast-control -[Xaero's Minimap]: https://www.curseforge.com/minecraft/mc-mods/xaeros-minimap -[Xaero's World Map]: https://www.curseforge.com/minecraft/mc-mods/xaeros-world-map - -### Visual - -- ![](icon/mr.png) [Distant Horizons] *(optional)* - See further in your world with far chunks rendered at lower detail -- ![](icon/mr.png) [Ears] - Customize your skin with ears, snouts, muzzles, horns, wings, ... -- ![](icon/cf.png) [Loot Beams] *(recommended)* - Shows loot beams on dropped items -- ![](icon/mr.png) [Neko's Enchanted Books] - Unique textures for enchanted books -- ![](icon/mr.png) [No More Night Vision Flashing!] - Removes flashing effect when night vision is running out -- ![](icon/cf.png) [Pick Up Notifier] - Shows a log of items and experience picked up by the player - -[Distant Horizons]: https://modrinth.com/mod/distanthorizons -[Ears]: https://modrinth.com/mod/ears -[Loot Beams]: https://www.curseforge.com/minecraft/mc-mods/loot-beams -[Neko's Enchanted Books]: https://modrinth.com/mod/nekos-enchanted-books -[No More Night Vision Flashing!]: https://modrinth.com/mod/no-nv-flash -[Pick Up Notifier]: https://www.curseforge.com/minecraft/mc-mods/pick-up-notifier - -# Sound - -- ![](icon/cf.png) [Presence Footsteps] *(recommended)* - Improved footstep sounds -- ![](icon/cf.png) [Sound Physics Remastered] *(optional)* - Provides realistic sound attenuation, reverberation, and absorption - -[Presence Footsteps]: https://www.curseforge.com/minecraft/mc-mods/presence-footsteps-forge -[Sound Physics Remastered]: https://modrinth.com/mod/sound-physics-remastered diff --git a/docs/icon/cf.png b/docs/icon/cf.png deleted file mode 100644 index d1aa14f74f765359aa30e50b9ba5e8ea541792db..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 285 zcmV+&0pk9NP)dFOoy1&1_5Ky88DDeQ@fLYn*|Bu#b{}1!?1o8g@@y)=%Kqj2w z0F)F38uT2jInDfkU5@qtn=MNJi-0ZxivI@UUSa}s5y*h&1uB2v%oF?nCSURYvRG5F zi+p{3lL#6Bw8a|KCX0_#f}*4hr1IKsg(tq7Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>D02*{fSaefwW^{L9 za%BKeVQFr3E>1;MAa*k@H7+qRNAp5A0004(Nklq3TmZ|qP2pB zs3^#OfZz}K1NLHXVQuFNE7@NBge~+NRAj+QNiwsO$z!sZ-SOO*yUs4b;*h!Lo^$5T zOgwAt2;w;2?{>RaLWox(r7nRranu{vyTznX>i*03?SCK*Y1#K@7UH?iPzTa-NEv|C zR@qRhon_e;xHF9Vj`3dzp%4b#39wC?O4}*}VA$bgob#GUU>caJ)?81}nl!8@FYP`& zH;7HgREs1@nye?Uhw(a8;M>dde5KCh!Wgp*ZC-gg6ky6C3_t1&bs%jOU??D~0u-8! zad8bAp_EY-ka_fzP(i>29o85|ptU|=J-lz8FXf#d1nAkK8%5u-F?+7Tg*IjvyM8(W zw_cj28%opkwg-rQzi$VF0UjjVVPjDgO>hAl8B)siQV;~e4H1d8Yj~!kNb9yzYLx@% zd2zgP^9A*WkVZ9%8r%zF&^k`iG0000EX>4Tx04R}tkvmAkKpe)uri!nMgB`>NWT;LSM5Q=t6^c+H)C#RSm|XgTCJjl7 zi=*ILaPYBMb#QUk)xlK|1Ro%7Zcd6WQsV!TLW@`rj{EW5eIIw<0YbING^=d_&~)2O z#G+yrnM}+R2Z_a86Dv*3@}@>SO&n4+o$`g0 z$13M7&RVg|>i6U?3}p0`Wvu?$|#@+8(~^?QY<8BKia}S==vpcDdZ}E zkz)ZRXpmh$_#gc4*2+#zdP#vO(Ej2$AEQ9WE>NpD&iAq7)J_2ZGjOFh{G}=|^GSN8 zp@oiszHQ**x}hn1z~v4w@MOrQ>`H!`LN*J$pV2p^f&N>dd(G>uzK_!fAW2=tZ-9eC zU@S-3>n+~h+1%T|XX^d^0I`5_z#T3uNdN!<24YJ`L;zO+7yu)~A}byM000SaNLh0L z04^f{04^f|c%?sf00007bV*G`2jvSL2_7K70J>TL000?uMObu0Z*6U5Zgc=ca%Ew3 zWn>_CX>@2HM@dakSAh-}00087Nkl|}V6hG`i!p|j=G`drQJ+uZl> zW`bo`(R260%fs`&&+|x(g#@es763|O4gmLoroSzZ#yVS$@u;^vZHkg@VVu>75D*Ct z6Yz&u+jY!{FdcY;toX8Q0M@`Er zHV>|=%@Mwf9pJs1JE3l@UiAQysj=vA~ zcMYGF^NdHl%N3=&Ssnb+7Oe_?)tERV1wb+UVPn^u2kPLkreic4$SSbfWRG!c*`BFN z_B;oZW~SN!PdujomV?ua_f4o$do-S3QCsKlNH20Pl93D&LKg@f3?_*meNk@geb)l4 z0xo10nag`xqX$huyD`atyF^BrYAMPpNJWne0UvtE zD*+wAF(F~2@1jR+I_nnst5bF0mUpd9WG_yR0H=Ur;8E#8mzc9f7QlW06QK5X#Hza* z`|G_G8GQQ?rn~uPKXC8GwcuqS49rw!nC{H?xzg;eWIjF%YQU4RQC@F9mcJ|=Aztszm(~p>ii2vP#l3+dXk6$0000