Improve Documentation

CHANGELOG.md

@@ -1,4 +1,4 @@
 # Changelog
 
-**1.0**
+**1.0.0**
 * Initial Release

README.md

@@ -3,63 +3,8 @@ A simple survival mod for Minecraft encouraging a nomadic lifestyle.
 
 Created For [ModFest 1.16](https://modfest.net/1.16)
 
-## Backpacks
+## Documentation
-A backpack can only hold one type of item or only hold unstackable items.
+[View Documentation](docs/README.md)
-
-### Small Backpack Recipe
-<table>
-<tr><th>Stick</th><th>Leather</th><th>Stick</th></tr>
-<tr><th>Leather</th><th>Iron Ingot</th><th>Leather</th></tr>
-<tr><th>Stick</th><th>Leather</th><th>Stick</th></tr>
-</table>
-
-### Large Backpack Recipe
-Combine a Small Backpack with a Gold Ingot in the Smithing Table.
-
-### Dye Backpack Recipe
-Combine a Backpack with a dye in the Crafting Table.
-
-## End Rods
-Most hostile mobs are afraid of End Rods.
-
-## Glowing Obsidian
-Glowing Obsidian heals monsters and hurts everything else. It naturally generates in small patches underground.
-
-### Recipe
-<table>
-<tr><th></th><th>Redstone</th><th></th></tr>
-<tr><th>Redstone</th><th>Obsidian</th><th>Redstone</th></tr>
-<tr><th></th><th>Redstone</th><th></th></tr>
-</table>
-
-## Chest Boats
-Right-Click a Boat with a Chest to place it in the Boat, you can also use an Ender Chest, Trapped Chest, Barrel, Crafting Table, or Shulker Box. Shift-Right-Click the Boat to open the Chest. You can also open the Chest inside the Boat by opening your inventory.
-
-## Difficulty Stages
-Each player has a "personal" stage of an area, the highest online player's difficulty stage in an area will be the "effective" difficulty stage of that area.
-
-### Stage 1
-- Normal Gameplay
-
-### Stage 2
-- Hostile Mobs Attack Passive Mobs
-
-### Stage 3
-- Mobs Are Guaranteed To Have At Least One Piece Of Armor
-
-### Stage 4
-- Villages Kick You Out (Using Iron Golems)
-- Creepers Target Artificial Blocks
-
-### Stage 5
-- Neutral Mobs Are Always Hostile
-- Mobs No Longer Have Knockback
-
-### Stage 6
-- Mobs No Longer Burn In Sunlight
-
-### Technical Details
-Each player has a 6-element long list in their data. Each element in the list has a chunk position and time value. Every tick the player will first, find the stage element its current position is in, and increase the time value of that stage element. If the time value when increased is over 24,000 ticks the next stage element will have its chunk set to the players current position, have its time value reset, the old stage element will have the next stage element's old chunk, and have its time value reset. To determine if a player is in a stage element, it checks if the player is within 16 chunks of the stage element's chunk, it starts searching at the last element, ending at the first. The "effective" stage element of a chunk can be found by searching every **online** player for their stage element for the chunk and then picking the highest value.
 
 ## Changelog
 [View Changelog](CHANGELOG.md)

docs/ADDITIONAL_FEATURES.md

@@ -0,0 +1,7 @@
+# Additional Features
+
+## End Rods
+Most hostile mobs are afraid of End Rods.
+
+## Chest Boats
+Right-Click a Boat with a Chest to place it in the Boat, you can also use an Ender Chest, Trapped Chest, Barrel, Crafting Table, or Shulker Box. Shift-Right-Click the Boat to open the Chest. You can also open the Chest inside the Boat by opening your inventory.

docs/BLOCKS.md

@@ -0,0 +1,11 @@
+# Blocks
+
+## Glowing Obsidian
+Glowing Obsidian heals monsters and hurts everything else. It naturally generates in small patches underground.
+
+### Recipe
+<table>
+<tr><th></th><th>Redstone</th><th></th></tr>
+<tr><th>Redstone</th><th>Obsidian</th><th>Redstone</th></tr>
+<tr><th></th><th>Redstone</th><th></th></tr>
+</table>

docs/GAMEPLAY.md

@@ -0,0 +1,27 @@
+# Gameplay
+
+## Difficulty Stages
+Each player has a "personal" difficulty stage of an area, the highest online player's difficulty stage in an area will be the "effective" difficulty stage of that area.
+
+### Stage 1
+- Normal Gameplay
+
+### Stage 2
+- Hostile Mobs Attack Passive Mobs
+
+### Stage 3
+- Mobs Are Guaranteed To Have At Least One Piece Of Armor
+
+### Stage 4
+- Villages Kick You Out (Using Iron Golems)
+- Creepers Target Artificial Blocks
+
+### Stage 5
+- Neutral Mobs Are Always Hostile
+- Mobs No Longer Have Knockback
+
+### Stage 6
+- Mobs No Longer Burn In Sunlight
+
+### Technical Details
+Each player has a 6-element long list in their NBT data. Each element in the list has a chunk position and time value. Every tick, the player will first find which stage element's area its current position is in, and then increase the time value of that stage element. If the time value when increased is over 24,000 ticks the next stage element will have its chunk set to the players current position, have its time value reset, the old stage element will have the next stage element's old chunk, and have its time value reset. To determine if a player is in a stage element, it checks if the player is within 16 chunks of the stage element's chunk, it starts searching at the last element, ending at the first. The "effective" stage element of a chunk can be found by searching every **online** player for their stage element for the chunk and then picking the highest value.

docs/ITEMS.md

@@ -0,0 +1,27 @@
+# Items
+
+## Backpacks
+A backpack can only hold one type of item or only hold unstackable items.
+
+### Small Backpack Recipe
+<table>
+<tr><th>Stick</th><th>Leather</th><th>Stick</th></tr>
+<tr><th>Leather</th><th>Iron Ingot</th><th>Leather</th></tr>
+<tr><th>Stick</th><th>Leather</th><th>Stick</th></tr>
+</table>
+
+### Large Backpack Recipe
+Combine a Small Backpack with a Gold Ingot in the Smithing Table.
+
+### Dye Backpack Recipe
+Combine a Backpack with a dye in the Crafting Table.
+
+## Diviner
+The Diviner will passively show you the effective stage of the area you are in with your action bar when it is in your inventory, and when used activly will print both your personal and effective stages and their remaining time.
+
+### Diviner Recipe
+<table>
+<tr><th></th><th>Iron Ingot</th><th></th></tr>
+<tr><th>Iron Ingot</th><th>Ender Pearl</th><th>Iron Ingot</th></tr>
+<tr><th></th><th>Iron Ingot</th><th></th></tr>
+</table>

docs/README.md

@@ -0,0 +1,9 @@
+# Documentation
+
+[View Gameplay](GAMEPLAY.md)
+
+[View Items](ITEMS.md)
+
+[View Blocks](BLOCKS.md)
+
+[View Additional Features](ADDITIONAL_FEATURES.md)

gradle.properties

@@ -3,11 +3,11 @@ org.gradle.jvmargs = -Xmx1G
 
 # Fabric Properties
 	# check these on https://fabricmc.net/use
-	minecraft_version = 1.16-pre8
+	minecraft_version = 1.16-rc1
 	curseforge_id = 390028
 	simple_minecraft_version = 1.16-Snapshot
-	yarn_build = 2
+	yarn_build = 4
-	fabric_loader_version = 0.8.7+build.201
+	fabric_loader_version = 0.8.8+build.202
 
 # Mod Properties
 	mod_version = 1.0.0
@@ -15,4 +15,4 @@ org.gradle.jvmargs = -Xmx1G
 
 # Dependencies
 	# currently not on the main fabric site, check on the maven: https://maven.fabricmc.net/net/fabricmc/fabric-api/fabric-api
-	fabric_api_version = 0.12.4+build.365-1.16
+	fabric_api_version = 0.12.5+build.367-1.16