README.md

   1 # BoundingBoxOutlineReloaded
   2
   3 BoundingBoxOutlineReloaded is a mod for Minecraft 1.8 using Forge API.
   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 - Strongholds; yellow boxes show each room in the stronghold. Does anyone make anything with silverfish spawners?
  20 - Mine Shafts; light gray boxes illustrate each of the mine shafts. Cobwebs... grrr!
  21 - Villages; multicoloured spheres encircle  the village, with boxes marking if and where iron golems will spawn. You should see the iron titan... CRAZY!
  22 - 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...
  23 - World Spawn & spawn chunks; red boxes outline the world spawn and the spawn chunks.
  24
  25 # How it works
  26
  27 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.
  28
  29 # Installing
  30
  31 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.
  32
  33 # Configuring
  34
  35 The keyboard shortcut can be configured in the standard Controls screen.
  36
  37 There are two ways to edit the config - in game or cfg file editing (although cfg editing is the only option on SMP servers.)
  38
  39 The following options are available for configuration
  40
  41 Option | Client/Server | Description | Cfg File Key | Cfg File Values | Default
  42 --- | --- | --- | --- | --- | ---
  43 Nether Fortresses | Both | Process/Render Nether Fortresses | drawNetherFortresses | true/false | true
  44 Witch Huts | Both | Process/Render Witch Huts | drawWitchHuts | true/false | true
  45 Desert Temples | Both | Process/Render Desert Temples | drawDesertTemples | true/false | true
  46 Jungle Temples | Both | Process/Render Jungle Temples | drawJungleTemples | true/false | true
  47 Ocean Monuments | Both | Process/Render Ocean Monuments | drawOceanMonuments | true/false | true
  48 Strongholds | Both | Process/Render Strongholds | drawStrongholds | true/false | false
  49 Mine Shafts | Both | Process/Render Mine Shafts | drawMineShafts | true/false | false
  50 Villages | Both | Process/Render Villages | drawVillages | true/false | true
  51 Village spheres | Client | Render Villages as spheres instead of cuboids | renderVillageAsSphere | true/false | true
  52 Village Iron Golem Spawn Area | Client | Render Iron Golem Spawn Area within valid Villages | drawIronGolemSpawnArea | true/false | true
  53 Slime Chunks | Both | Process/Render Slime Chunks | drawSlimeChunks | true/false | true
  54 Slime Chunks Maximum Y | Client | Maximum Y value of the dynamic slime chunk boxes | slimeChunkMaxY | -1-255 (see below) | 0
  55 World Spawn | Both | Process/Render World Spawn & Spawn Chunks | drawWorldSpawn | true/false | true
  56 World Spawn Maximum Y | Client | Maximum Y value of the world spawn & spawn chunk boxes | worldSpawnMaxY | -1-255 (see below) | 0
  57 Fill | Client | Fill the bounding boxes (except village ones) | fill | true/false | false
  58 Always Visible | Client | Bounding boxes are visible through blocks - kinda messes with perspective tho! | alwaysVisible | true/false | false
  59 Keep Cache Between Sessions | Client | Bounding box caches are not cleared when disconnecting from single or multiplayer worlds. | keepCacheBetweenSessions | true/false | false
  60
  61 The Maximum Y value configuration options have some special values, these are:-
  62 * -1 = the Y value of the players feet when the bounding boxes were activated.
  63 * 0 = the current Y value of the players feet.
  64
  65 ### In game
  66
  67 *Note: In game editing is incomplete.*
  68
  69 Forge provides a UI to edit configuration of mods - this mod provides the ability to control many aspects of the mods behaviour.  On the home screen of Minecraft select the Mods button, select this mod and click on the config button.
  70
  71 ### Cfg file editing
  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
  79 # Using with vanilla servers
  80
  81 There are two options when you want bounding boxes to show whilst accessing vanilla servers:-
  82
  83 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.
  84 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:-
  85   - level.dat; include this for world spawn, spawn and slime chunks to be rendered.
  86   - Fortress.dat; include this for Nether Fortresses to be rendered.
  87   - Mineshaft.dat; include this for Mineshafts to be rendered.
  88   - Monument.dat; include this for Ocean Monuments to be rendered.
  89   - Stronghold.dat; include this for Strongholds to be rendered.
  90   - Temple.dat; include this for Desert & Jungle Temples and witch huts to be rendered.
  91
  92   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.
  93
  94 # Links
  95 - Forge 1.8 - [Download](http://files.minecraftforge.net/minecraftforge/1.8)
  96 - 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)
  97 - KaboPC's VillageMarker mod - [Forum](http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1288327-village-marker-mod)