]> git.lizzy.rs Git - BoundingBoxOutlineReloaded.git/blobdiff - README.md
Add initial 1.10 vanilla support
[BoundingBoxOutlineReloaded.git] / README.md
index 501aa3ef89131a4665f300ddeeb829a1018cc742..7818cbbbc7997bfbb548a86edc8c330e7109f1fb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # BoundingBoxOutlineReloaded
 
-BoundingBoxOutlineReloaded is a mod for Minecraft Forge 1.8 and Vanilla 1.8.1, 1.8 & 1.7.10.
+BoundingBoxOutlineReloaded is a mod for Minecraft 1.10 Vanilla
 
 # Why did I make it?
 
@@ -16,6 +16,7 @@ This mod highlights in a variety of colours and styles the different structures
 - Desert Temples; orange boxes envelop the pyramid and towers. Go grab some loot but beware TNT boobie traps!
 - Jungle Temples; green boxes surround the temple. Indianna Jones would've love these!
 - Ocean Monuments; cyan boxes indicate where guardians spawn. New sea lantern and prismarine block types FTW.
+- End Cities; magenta boxes show the rooms, corridors and air ships in the End. Time to fall with style!
 - Strongholds; yellow boxes show each room in the stronghold. Does anyone make anything with silverfish spawners?
 - Mine Shafts; light gray boxes illustrate each of the mine shafts. Cobwebs... grrr!
 - Villages; multicoloured spheres encircle  the village, with boxes marking if and where iron golems will spawn. You should see the iron titan... CRAZY!
@@ -26,11 +27,7 @@ This mod highlights in a variety of colours and styles the different structures
 
 As chunks are loaded the game provides metadata about all the different structures & features in those chunks.  The mod interprets this meta data, caches the results, and renders the bounding boxes to the screen.  In an SMP environment this data is not present on the clients so the mod needs to run on the server where the processing happens and then the relevant metadata is sent to the clients for them to render.
 
-# Installing (Forge)
-
-Make sure you have Forge 1.8 installed then drop the jar file into the mods/1.8 folder.  Remember this will need to be installed on client and server in an SMP scenario (unless you use local dat files - see below)
-
-# Installing (Vanilla)
+# Installing
 
 Copy the contents of the Vanilla archive into the JAR file as per usual.  In a SMP scenario you'll need to use local dat files - see below.
 
@@ -47,6 +44,7 @@ Witch Huts | Both | Process/Render Witch Huts | drawWitchHuts | true/false | tru
 Desert Temples | Both | Process/Render Desert Temples | drawDesertTemples | true/false | true
 Jungle Temples | Both | Process/Render Jungle Temples | drawJungleTemples | true/false | true
 Ocean Monuments | Both | Process/Render Ocean Monuments | drawOceanMonuments | true/false | true
+End Cities | Both | Process/Render End Cities | drawEndCities | true/false | true
 Strongholds | Both | Process/Render Strongholds | drawStrongholds | true/false | false
 Mine Shafts | Both | Process/Render Mine Shafts | drawMineShafts | true/false | false
 Villages | Both | Process/Render Villages | drawVillages | true/false | true
@@ -71,15 +69,17 @@ Open the config/BBOutlineReloaded.cfg file with your text editor of choice and c
 # Using
 
 Press B, sit back and enjoy the goodness flowing onto your screen.
+Press O to switch the "Display Outer Boxes Only" mode on and off, this will allow you to see the full boundary of Nether Fortresses, End Cities, Strongholds and Mineshafts
 
 # Using with vanilla servers
 
 There are two options when you want bounding boxes to show whilst accessing vanilla servers:-
 
 1. Keep cache - With the "Keep Cache Between Sessions" config setting enabled, Open a copy of the world in single player and move around to capture all the structures you want in the cache. Once you are happy with the structures you have cached, quit the single player game and connect to the server without closing Minecraft.  You will see all the structures from the cache.
-2. Load dat files - Copy the dat files listed below into config/BBOutlineReloaded/{host},{port} and these will be loaded when you connect to the vanilla server.  {host} is the name or ip you use to connect to the server; {port} is the port you specify when connecting.  The mod will load any/all of following files:-
+2. Load dat files - Copy the dat files listed below into config/BBOutlineReloaded/{host}/{port} and these will be loaded when you connect to the vanilla server.  {host} is the name or ip you use to connect to the server; {port} is the port you specify when connecting.  The mod will load any/all of following files:-
   - level.dat; include this for world spawn, spawn and slime chunks to be rendered.
   - Fortress.dat; include this for Nether Fortresses to be rendered.
+  - EndCities.dat; include this for EndCities to be rendered.
   - Mineshaft.dat; include this for Mineshafts to be rendered.
   - Monument.dat; include this for Ocean Monuments to be rendered.
   - Stronghold.dat; include this for Strongholds to be rendered.
@@ -88,6 +88,5 @@ There are two options when you want bounding boxes to show whilst accessing vani
   It is also possible to include the villages.dat, villages_end.dat & villages_nether.dat files and it will render villages however these files only contain the villages that were loaded when the files were copied and will not handle any changes that occur with villages such as when doors are added/removed or villager population changes.
 
 # Links
-- Forge 1.8 - [Download](http://files.minecraftforge.net/minecraftforge/1.8)
 - 4poc's BBOutline mod - [Forum](http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1286555-bounding-box-outline) | [Source](http://www.github.com/4poc/bboutline)
 - KaboPC's VillageMarker mod - [Forum](http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1288327-village-marker-mod)