Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheGrimsey authored Mar 21, 2021
1 parent 15d7bf7 commit d1ae458
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
# Stoneholm

Stoneholm is a **Fabric mod** that adds underground villages to the world. Inspired by Strongholds and Villages (surprise, huh?).
Stoneholm is a **Fabric mod** for **1.16** that adds underground villages to the world. Inspired by Strongholds and Villages (surprise, huh?).

Explore underground villages that have grown into mazes of hallways, stairs, workspaces, abandoned sections, and overgrown areas.

*A Forge port is* ***not*** *planned currently but may happen in the future.*
**Backports** will not be done.

# Requirements

Stoneholm depends on **[Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api)** and **[Cloth Config](https://www.curseforge.com/minecraft/mc-mods/cloth-config).**

# Screenshots
<p><img src="/img/SC_Outside.jpg" alt="A picture showing a possible entrance to a village." width="900"/></p>

<p><img src="/img/SC_Room.jpg" alt="A picture showing a room inside of a village." width="900"/></p>

<p><img src="/img/SC_Cartographer.jpg" alt="A picture showing a cartographer's room in a village." width="900"/></p>

<p><img src="/img/SC_Overgrown.jpg" alt="A picture showing an overgrown section looking into an armorer's room." width="900"/></p>

<p><img src="/img/SC_abandoned.jpg" alt="A picture showing an abandoned section." width="900"/></p>

# Technical Info

Underground Villages are jigsaw structures that make use of template pools and processors as well as structure files. There isn't a ton of easy to understand information about creating jigsaw structures but [TelepathicGrunt's StructureTutorialMod repo](https://github.com/TelepathicGrunt/StructureTutorialMod) has been very helpful when developing this mod.

## License

This mod is available under the MIT license. You are free to port, modify, use it as you wish.
This mod is available under the MIT license. You are free to port, modify, use it as you wish.

0 comments on commit d1ae458

Please sign in to comment.