README.md

   1 # BoundingBoxOutlineReloaded
   2
   3 BoundingBoxOutlineReloaded is a mod for Minecraft Vanilla, Forge, LiteLoader, Rift, and Fabric
   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; dark 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; dark 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 - Igloos (*); white boxes show where igloos are. Maybe you can convert the zombie villager back?
  27 - Shipwrecks (*); cyan boxes are like a lighthouse those wary sailors wish they'd had. Time to find some buried treasure?
  28 - Ocean ruins (*); cyan boxes show the different ocean ruin structures. Watch out for those pesky drowns tho!
  29 - Buried treasure (*); cyan boxes highlight where the heart of the sea can be found. Conduit anyone?
  30 - Mob Spawners; bright green boxes show where mob spawners are, where mobs will be spawned, and red/orange/green lines help the player see if a spawner is nearby and activated.
  31 - Pillager Outposts; grey boxes outline where crossbow wielding pillagers will spawn. Beware of bad omens tho!
  32
  33 (*) Due to how Minecraft generates these structures they will initially float above where they should be, however upon re-logging they should drop down to the correct height. Unfortunately (or fortunately?) buried treasure will always appear at y-90 (unless Mojang change something that is!)
  34
  35 ## How it works
  36
  37 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.
  38
  39 ## Installing (Forge/LiteLoader/Rift/Fabric)
  40
  41 Make sure you have the relevant mod loader installed then drop the mod file into the appropriate mods folder. This approach can be used for client and server deployments where needed.
  42
  43 ## Installing (Vanilla)
  44
  45 Double-click the jar file and a client profile for the relevant version of Minecraft will be created/updated in the launcher.
  46
  47 ## Running a server (Vanilla)
  48
  49 To start a vanilla server with the mod loaded, copy the relevant jar file to a folder, and run:-
  50 ```
  51 java -jar BBOutlineReloaded-{version}.jar --server
  52 ```
  53
  54 Running this will download the necessary pre-requisities and start the server.
  55
  56 ## Configuring
  57
  58 The keyboard shortcuts can be configured in the standard Controls screen.
  59
  60 The following options are available for configuration on the client through a configuration Gui. On Vanilla, Rift & Fabric there is a BBOR button on the options screen, alternatively press and hold B key when in game.
  61
  62 Option | Description | Cfg File Key | Cfg File Values | Default
  63 --- | --- | --- | --- | ---
  64 Nether Fortresses | Process/Render Nether Fortresses | drawNetherFortresses | true/false | true
  65 Witch Huts | Process/Render Witch Huts | drawWitchHuts | true/false | true
  66 Desert Temples | Process/Render Desert Temples | drawDesertTemples | true/false | true
  67 Jungle Temples | Process/Render Jungle Temples | drawJungleTemples | true/false | true
  68 Ocean Monuments | Process/Render Ocean Monuments | drawOceanMonuments | true/false | true
  69 End Cities | Process/Render End Cities | drawEndCities | true/false | true
  70 Strongholds | Process/Render Strongholds | drawStrongholds | true/false | false
  71 Woodland Mansions | Process/Render Mansions | drawMansions | true/false | true
  72 Mine Shafts | Process/Render Mine Shafts | drawMineShafts | true/false | false
  73 Igloos | Process/Render Igloos | drawIgloos | true/false | true
  74 Shipwrecks | Process/Render Shipwrecks | drawShipwrecks | true/false | true
  75 Ocean Ruins | Process/Render Ocean Ruins | drawOceanRuins | true/false | true
  76 Buried Treasure | Process/Render Buried Treasure | drawBuriedTreasure | true/false | true
  77 Mob Spawner | Process/Render Mob Spawners | drawMobSpawners | true/false | true
  78 Mob Spawner Spawn Area | Render where mobs will be spawned | renderMobSpawnerSpawnArea | true/false | true
  79 Mob Spawner Activation Lines | Render red/orange/green lines to show nearby spawners and if they are active | renderMobSpawnerActivationLines | true/false | true
  80 Pillager Outposts | Process/Render Pillager Outpoints | drawPillagerOutposts | true/false | true
  81 Villages | Process/Render Villages | drawVillages | true/false | true
  82 Village spheres | Render Villages as spheres instead of cuboids | renderVillageAsSphere | true/false | true
  83 Village sphere dot size | The size of the dots used when rendering village as sphere | villageSphereDotSize | 1-5 | 3
  84 Village sphere density | The density of the dots used when rendering village as sphere | villageSphereDensity | 1-5 | 3
  85 Village Iron Golem Spawn Area | Render Iron Golem Spawn Area within valid Villages | drawIronGolemSpawnArea | true/false | true
  86 Village doors | Render lines between village centre and doors | drawVillageDoors | true/false | false
  87 Slime Chunks | Process/Render Slime Chunks | drawSlimeChunks | true/false | true
  88 Slime Chunks Maximum Y | Maximum Y value of the dynamic slime chunk boxes | slimeChunkMaxY | -1-255 (see below) | -1
  89 World Spawn | Process/Render World Spawn & Spawn Active Chunks | drawWorldSpawn | true/false | true
  90 World Spawn Maximum Y | Maximum Y value of the world spawn & spawn chunk boxes | worldSpawnMaxY | -1-255 (see below) | -1
  91 Lazy Spawn Chunks | Process/Render Lazy Spawn Chunks | drawLazySpawnChunks | true/false | false
  92 Fill | Fill the bounding boxes (except village ones) | fill | true/false | true
  93 Always Visible | Bounding boxes are visible through blocks - kinda messes with perspective tho! | alwaysVisible | true/false | false
  94 Keep Cache Between Sessions | Bounding box caches are not cleared when disconnecting from single or multiplayer worlds. | keepCacheBetweenSessions | true/false | false
  95 Outer Boxes Only | Render outer bounding boxes only | outerBoxesOnly | true/false | false
  96
  97 The Maximum Y value configuration options have some special values, these are:-
  98 * -1 = the Y value of the players feet when the bounding boxes were activated.
  99 * 0 = the current Y value of the players feet.
 100
 101 Another option to configure is to open the config/BBOutlineReloaded.cfg file with your text editor of choice and change the settings. Simples! Minecraft Client will need to be restarted for the settings changed this way to take effect.
 102
 103 ## Using
 104
 105 - Press B, sit back and enjoy the goodness flowing onto your screen.
 106 - Press and hold B to open the configuration Gui.
 107 - 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
 108
 109 ## Bounding boxes when connected to servers
 110
 111 There are a few options when you want bounding boxes to show whilst accessing servers:-
 112
 113 - Use a modded server - Ensure the server is running with this mod loaded (as described above), and connect to the server with a client with this mod loaded.
 114 - 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.
 115 - 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:-
 116   - level.dat; include this for world spawn, spawn and slime chunks to be rendered.
 117   - Fortress.dat; include this for Nether Fortresses to be rendered.
 118   - EndCities.dat; include this for EndCities to be rendered.
 119   - Mineshaft.dat; include this for Mineshafts to be rendered.
 120   - Monument.dat; include this for Ocean Monuments to be rendered.
 121   - Stronghold.dat; include this for Strongholds to be rendered.
 122   - Mansion.dat; include this for Mansions to be rendered.
 123   - Temple.dat; include this for Desert & Jungle Temples and witch huts to be rendered.
 124
 125 (*) This is becoming more and more irrelevant as dat files are being phased out, and this feature may be removed/replaced in the future.
 126
 127 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.
 128
 129 ## Links
 130 - Forge - [Download](https://files.minecraftforge.net/)
 131 - 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)
 132 - KaboPC's VillageMarker mod - [Forum](http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1288327-village-marker-mod)