Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
FakeDomi committed Jun 10, 2022
1 parent 3fb473a commit bb13bf0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# FastChest

**Requires [Fabric API](https://github.com/FabricMC/fabric/releases).** If you have a lot of chests nearby, you have probably noticed how bad Minecraft is at rendering them. The more chests you place, the lower your FPS go.

This mod helps by removing dynamic models from chests and making them render as static chunk geometry like normal blocks. (This means they will lose their lid opening animation!)

Depending on how many chests you have around you'll see varying effectiveness. In large storage rooms this mod can easily double your FPS. Keep in mind this mod only focuses on chests, and there might be other things crippling your FPS.

FastChest works with Sodium and Optifine and should be compatible with all other mods and resource packs that leave chests alone. One example that does not is the *Vanilla Tweaks Proper Break Particles* resource pack. It overwrites the chest blockstate definitions and is not compatible out of the box. You can however delete `chest.json`, `ender_chest.json` and `trapped_chest.json` from the `/assets/minecraft/blockstates` directory of your resource pack to make it work with the mod.
2 changes: 1 addition & 1 deletion src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"eeasee"
],
"contact": {
"homepage": "https://www.curseforge.com/minecraft/mc-mods/fastchest",
"homepage": "https://domi.re/mc-mods/fastchest",
"sources": "https://github.com/FakeDomi/FastChest",
"issues": "https://github.com/FakeDomi/FastChest/issues"
},
Expand Down

0 comments on commit bb13bf0

Please sign in to comment.