Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sigmastar00 committed Aug 18, 2023
1 parent d680a36 commit b2577cc
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Introduction

Soul Pyre is a survival-friendly datapack that adds a new buildable structure, the soul pyre.
Active soul pyres prevent natural hostile mob spawns in a 64 block radius around them, letting you build without having to worry about lighting!
It doesn't require any resource pack, and is available for Minecraft versions 1.16.5 and greater.

# Building

To build a soul pyre, start by placing down 4 crying obsidian in a square, 1 block apart each.

![Building a soul pyre, step 1](images/build1.png)

Then, place either soul sand or soul soil 1 block above in the center.

![Building a soul pyre, step 2](images/build2.png)

To activate the pyre, light the soul sand on fire. If it worked, you'll see green particles and hear a blaze sound effect.

![Activating a soul pyre](images/build3.png)

The empty spaces are free to fill with whichever blocks you want!

![Decorating a soul pyre](images/build4.png)

# More Information

Once built, a pyre will stay active until any of the blocks it's made of get removed. This includes the fire on top, which is considered part of the structure.

An active pyre will despawn mobs that spawn within 64 blocks of itself.
However, mobs that have already been spawned, either during worldgen, or because they were outside the radius, are immune to this.
This means you should still build walls around any areas you don't want hostiles walking into.

Mobs that spawn as part of a raid are unaffected by pyres.

The list of mobs the pyre protects against can be configured using the tag `sigmastar:pyre/pyre_despawn`. By default this tag includes the following mobs:

- Creeper
- Drowned
- Enderman
- Ghast
- Hoglin
- Husk
- Magma Cube
- Phantom
- Piglin
- Pillager
- Skeleton
- Slime
- Spider
- Stray
- Witch
- Zoglin
- Zombie
- Zombie Villager
- Zombified Piglin

This default list is meant to protect against hostiles that can spawn naturally without needing a spawner, a structure, or player action.
Binary file added images/build1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/build2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/build3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/build4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b2577cc

Please sign in to comment.