Skip to content

Commit e891cc8

Browse files
committed
feat: re-add readme stuff
1 parent 1b6f1a9 commit e891cc8

3 files changed

Lines changed: 33 additions & 0 deletions

File tree

2.19 KB
Loading

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Mismatched chests
2+
3+
![Mod logo](src/main/resources/assets/mismatched_chests/icon.png)
4+
5+
Mismatched Chests is a simple mod that allows you to combine two chests of different wood types to create a double chest, as if they were the same. It's designed to work with other mods that add new chests, such as [LieOnLion's More chest variants mod](https://modrinth.com/mod/more-chest-variants-lieonlion), so you can have an oak chest, and a cherry chest side-by-side and still have them function as a single, double chest!
6+
7+
![A cherry chest and an oak chest combined](.github/assets/cherry_oak_combined.png)
8+
9+
10+
## Features
11+
- Create a double chest using any two chests
12+
- The mod works with any mod that adds new chests, as long as they extend the `ChestBlock` class.
13+
14+
## Installation
15+
- Download [fabric 1.21+](https://fabricmc.net/use/installer/) from fabricmc
16+
- Download [Mismatched chests](https://modrinth.com/mod/mismatched-chests) from Modrinth or the [GitHub releases](https://github.com/NotGhoull/mismatched-chests/releases)
17+
- Place the downloaded `.jar` file in your `mods` folder
18+
- Launch and enjoy!
19+
20+
## Compatibility
21+
Mismatched chests should work with any extra chest mod, however is there are any issues please [report them](https://github.com/NotGhoull/mismatched-chests/issues/new), and we'll try to fix them.
22+
23+
## Licence
24+
This mod is open source and licensed under the **GPLv3 licence**. Feel free to fork the repository, make changes, and submit PRs!
25+
26+
## Tested mods
27+
- [More chest variants | LieOnLion](https://modrinth.com/mod/more-chest-variants-lieonlion)
28+
29+
## Known incompatibilities
30+
- Sophisticated Storage (Currently being worked on)
31+
32+
## Credits
33+
- Ghoul _"Look ma, I'm on TV"_ - Developer
153 KB
Loading

0 commit comments

Comments
 (0)