README.md

   1 # BoundingBoxOutlineReloaded
   2
   3 BoundingBoxOutlineReloaded is a mod for Minecraft Forge, LiteLoader, and Vanilla
   4
   5 # Why did I make it?
   6
   7 I loved 4poc's BBOutline mod but the only version I could get to work consistently was for Minecraft 1.6.4. This is fine if you want Nether Fortress bounding boxes but if you need witch huts the new block types can cause Minecraft 1.6.4 to crash horribly; and don't get me started on item frames crashing Minecraft 1.6.4!
   8
   9 In addition to this not working with newer worlds, the way it bounds villages lacks the finesse of KaboPC's VillageMarker mod, and any new structures introduced in Minecraft like Ocean Monuments are missing entirely.
  10
  11 # What it does
  12
  13 This mod highlights in a variety of colours and styles the different structures & features of the game:-
  14 - Nether Fortresses; red boxes bound each individual area where Blaze, Wither Skeletons & normal Skeletons will spawn. Time for a beacon methinks!
  15 - Witch Huts; blue boxes reveal everywhere only witches spawn. Witch farm anyone?
  16 - Desert Temples; orange boxes envelop the pyramid and towers. Go grab some loot but beware TNT boobie traps!
  17 - Jungle Temples; green boxes surround the temple. Indianna Jones would've love these!
  18 - Ocean Monuments; cyan boxes indicate where guardians spawn. New sea lantern and prismarine block types FTW.
  19 - End Cities; magenta boxes show the rooms, corridors and air ships in the End. Time to fall with style!
  20 - Strongholds; yellow boxes show each room in the stronghold. Does anyone make anything with silverfish spawners?
  21 - Woodland Mansions; brown boxes show each room in the woodland mansion. Here's Johnny!
  22 - Mine Shafts; light gray boxes illustrate each of the mine shafts. Cobwebs... grrr!
  23 - Villages; multicoloured spheres encircle  the village, with boxes marking if and where iron golems will spawn. You should see the iron titan... CRAZY!
  24 - Slime chunks; bright green boxes highlight where slimes will spawn, with a dynamic box that rises to where the players feet are to help find them from the surface. Bouncy... bouncy...
  25 - World Spawn & spawn chunks; red boxes outline the world spawn and the spawn chunks (active & lazy).
  26
  27 # How it works
  28
  29 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.
  30
  31 # Installing (Forge/LiteLoader)
  32
  33 Make sure you have Forge or LiteLoader installed then drop the mod file into the appropriate mods folder. [Forge Only] If you want to use client/server with your SMP server then make sure the mod is installed on both client and server.
  34
  35 # Installing (Vanilla)
  36
  37 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.
  38
  39 # Configuring
  40
  41 The keyboard shortcuts can be configured in the standard Controls screen.
  42
  43 The following options are available for configuration
  44
  45 Option | Client/Server | Description | Cfg File Key | Cfg File Values | Default
  46 --- | --- | --- | --- | --- | ---
  47 Nether Fortresses | Both | Process/Render Nether Fortresses | drawNetherFortresses | true/false | true
  48 Witch Huts | Both | Process/Render Witch Huts | drawWitchHuts | true/false | true
  49 Desert Temples | Both | Process/Render Desert Temples | drawDesertTemples | true/false | true
  50 Jungle Temples | Both | Process/Render Jungle Temples | drawJungleTemples | true/false | true
  51 Ocean Monuments | Both | Process/Render Ocean Monuments | drawOceanMonuments | true/false | true
  52 End Cities | Both | Process/Render End Cities | drawEndCities | true/false | true
  53 Strongholds | Both | Process/Render Strongholds | drawStrongholds | true/false | false
  54 Woodland Mansions | Both | Process/Render Mansions | drawMansions | true/false | true
  55 Mine Shafts | Both | Process/Render Mine Shafts | drawMineShafts | true/false | false
  56 Villages | Both | Process/Render Villages | drawVillages | true/false | true
  57 Village spheres | Client | Render Villages as spheres instead of cuboids | renderVillageAsSphere | true/false | true
  58 Village Iron Golem Spawn Area | Client | Render Iron Golem Spawn Area within valid Villages | drawIronGolemSpawnArea | true/false | true
  59 Village doors | Client | Render lines between village centre and doors | drawVillageDoors | true/false | false
  60 Slime Chunks | Client | Process/Render Slime Chunks | drawSlimeChunks | true/false | true
  61 Slime Chunks Maximum Y | Client | Maximum Y value of the dynamic slime chunk boxes | slimeChunkMaxY | -1-255 (see below) | -1
  62 World Spawn | Client | Process/Render World Spawn & Spawn Active Chunks | drawWorldSpawn | true/false | true
  63 World Spawn Maximum Y | Client | Maximum Y value of the world spawn & spawn chunk boxes | worldSpawnMaxY | -1-255 (see below) | -1
  64 Lazy Spawn Chunks | Client | Process/Render Lazy Spawn Chunks | drawLazySpawnChunks | true/false | false
  65 Fill | Client | Fill the bounding boxes (except village ones) | fill | true/false | true
  66 Always Visible | Client | Bounding boxes are visible through blocks - kinda messes with perspective tho! | alwaysVisible | true/false | false
  67 Keep Cache Between Sessions | Client | Bounding box caches are not cleared when disconnecting from single or multiplayer worlds. | keepCacheBetweenSessions | true/false | false
  68
  69 The Maximum Y value configuration options have some special values, these are:-
  70 * -1 = the Y value of the players feet when the bounding boxes were activated.
  71 * 0 = the current Y value of the players feet.
  72
  73 Open the config/BBOutlineReloaded.cfg file with your text editor of choice and change the settings.  Simples!  Minecraft (including servers) will need to be restarted for the settings to take effect.
  74
  75 # Using
  76
  77 Press B, sit back and enjoy the goodness flowing onto your screen.
  78 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
  79
  80 # Using with vanilla servers
  81
  82 There are two options when you want bounding boxes to show whilst accessing vanilla servers:-
  83
  84 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.
  85 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:-
  86   - level.dat; include this for world spawn, spawn and slime chunks to be rendered.
  87   - Fortress.dat; include this for Nether Fortresses to be rendered.
  88   - EndCities.dat; include this for EndCities to be rendered.
  89   - Mineshaft.dat; include this for Mineshafts to be rendered.
  90   - Monument.dat; include this for Ocean Monuments to be rendered.
  91   - Stronghold.dat; include this for Strongholds to be rendered.
  92   - Mansion.dat; include this for Mansions to be rendered.
  93   - Temple.dat; include this for Desert & Jungle Temples and witch huts to be rendered.
  94
  95 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.
  96
  97 # Links
  98 - Forge - [Download](https://files.minecraftforge.net/)
  99 - 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)
 100 - KaboPC's VillageMarker mod - [Forum](http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1288327-village-marker-mod)