Skip to content

Commit f6ef411

Browse files
committed
Updated Readme
1 parent ffcf45b commit f6ef411

4 files changed

Lines changed: 15 additions & 23 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
</div>
1313

1414
Mint ships **29** lightweight, vanilla-friendly gameplay modules. Each one can be toggled per-player, integrates with common protection plugins, supports multiple storage backends, and requires no client mods.
15-
We are talking Diamond Doors, Vertical Slabs, Mixed slabs and Colored ItemFrames. Make sure you checkout [Building Modules](docs/building.md)!
15+
16+
![](media/modules/block-decoration.png)
1617

1718
## Features
1819

docs/building.md

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# Building Modules
22

33
These modules focus on placement, decoration, and building convenience.
4+
## Vertical Slab
5+
- **Config key:** `modules.verticalslab`
6+
- **Description:** Enables vertical slab placement visuals.
7+
- **Permission node:** `mint.module.verticalslab` (default; override with `modules.verticalslab.permission`)
8+
9+
![Vertical Slab Preview](media/modules/vertical-slab.gif)
10+
11+
## Dyeable Item Frames
12+
- **Config key:** `modules.dyeable-item-frames`
13+
- **Description:** Dyes item frames using mixed dye combinations with a wool-style texture overlay.
14+
- **Permission node:** `mint.module.dyeable-item-frames` (default; override with `modules.dyeable-item-frames.permission`)
15+
16+
![Dyeable Item Frames Preview](media/modules/itemframes.png)
417

518
## Reacharound Placement
619
- **Config key:** `modules.reacharound-placement`
@@ -11,62 +24,42 @@ These modules focus on placement, decoration, and building convenience.
1124
- **Config key:** `modules.blockdecoration`
1225
- **Description:** Decorates supported blocks with display skins.
1326
- **Permission node:** `mint.module.blockdecoration` (default; override with `modules.blockdecoration.permission`)
14-
- **Preview:** `media/modules/block-decoration.gif`
1527

1628
![Block Decoration Preview](media/modules/block-decoration.gif)
1729

1830
## Carpet Geometry
1931
- **Config key:** `modules.carpetgeometry`
2032
- **Description:** Uses a stonecutter to craft geometric patterns into carpets.
2133
- **Permission node:** `mint.module.carpetgeometry` (default; override with `modules.carpetgeometry.permission`)
22-
- **Preview:** `media/modules/carpet-geometry.gif`
2334

2435
![Carpet Geometry Preview](media/modules/carpet-geometry.gif)
2536

2637
## Ladder Place
2738
- **Config key:** `modules.ladder-place`
2839
- **Description:** Places ladders quickly above or below your current position.
2940
- **Permission node:** `mint.module.ladder-place` (default; override with `modules.ladder-place.permission`)
30-
- **Preview:** `media/modules/fast-ladder.gif`
3141

3242
![Ladder Place Preview](media/modules/fast-ladder.gif)
3343

3444
## Sign Items
3545
- **Config key:** `modules.sign-items`
3646
- **Description:** Places items on hanging signs using display entities.
3747
- **Permission node:** `mint.module.sign-items` (default; override with `modules.sign-items.permission`)
38-
- **Preview:** `media/modules/signitems.png`
3948

4049
![Sign Items Preview](media/modules/signitems.png)
4150

4251
## Slab Breaker
4352
- **Config key:** `modules.slab-breaker`
4453
- **Description:** Breaks only one half of double slabs.
4554
- **Permission node:** `mint.module.slab-breaker` (default; override with `modules.slab-breaker.permission`)
46-
- **Preview:** `media/modules/slab-breaker.gif`
4755

4856
![Slab Breaker Preview](media/modules/slab-breaker.gif)
4957

5058
## Mixed Slab
5159
- **Config key:** `modules.mixedslab`
5260
- **Description:** Places two different slab types in one block space.
5361
- **Permission node:** `mint.module.mixedslab` (default; override with `modules.mixedslab.permission`)
54-
- **Preview:** `media/modules/mixed-slab.gif`
5562

5663
![Mixed Slab Preview](media/modules/mixed-slab.gif)
5764

58-
## Vertical Slab
59-
- **Config key:** `modules.verticalslab`
60-
- **Description:** Enables vertical slab placement visuals.
61-
- **Permission node:** `mint.module.verticalslab` (default; override with `modules.verticalslab.permission`)
62-
- **Preview:** `media/modules/vertical-slab.gif`
63-
64-
![Vertical Slab Preview](media/modules/vertical-slab.gif)
6565

66-
## Dyeable Item Frames
67-
- **Config key:** `modules.dyeable-item-frames`
68-
- **Description:** Dyes item frames using mixed dye combinations with a wool-style texture overlay.
69-
- **Permission node:** `mint.module.dyeable-item-frames` (default; override with `modules.dyeable-item-frames.permission`)
70-
- **Preview:** `media/modules/itemframes.png`
71-
72-
![Dyeable Item Frames Preview](media/modules/itemframes.png)

docs/entity.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ These modules modify mob and creature-specific behavior.
66
- **Config key:** `modules.chicken-glide`
77
- **Description:** Lets players carry chickens and glide with slow falling.
88
- **Permission node:** `mint.module.chicken-glide` (default; override with `modules.chicken-glide.permission`)
9-
- **Preview:** `media/modules/chicken-pickup.gif`
109

1110
![Chicken Glide Preview](media/modules/chicken-pickup.gif)
1211

docs/inventory.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ These modules streamline inventory management and tool usage.
1111
- **Config key:** `modules.auto-tool`
1212
- **Description:** Automatically switches to the proper tool when breaking blocks.
1313
- **Permission node:** `mint.module.auto-tool` (default; override with `modules.auto-tool.permission`)
14-
- **Preview:** `media/modules/autotool.gif`
1514

1615
![Auto Tool Preview](media/modules/autotool.gif)
1716

0 commit comments

Comments
 (0)