Update README.md

This commit is contained in:
bmgjet 2021-07-04 13:22:44 +12:00 committed by GitHub
parent 5292316547
commit 4e7fb01395
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions

View File

@ -1,2 +1,4 @@
<p><strong>BCargo</strong><br /> Blocks Cargoship from leaving while it is within a building blocked area.<br /> Allows to set a static spawn position for the cargo to stop it running though islands on its way into the nearest path node or to have it come down a river<br /> Add support for auto leveling of cargo when using tides plugin to stop it sinking below water level or flying in the air.<br /> <br /> <strong>How to use:</strong><br /> In your map editor. Stretch out some prevent building cubes along the part of the path you dont want cargo ship to exit on.<br /> It will continue along its path until its X distance from the prevent building cube before it leaves to the nearest edge.<br /> This stops it just running though the land and destroying any buildings on its way to the edge.</p>
<p><br /> <a title="Enlarge image" href="https://i.ibb.co/875WJqm/inlandcargo2.jpg" data-wrappedlink="" data-ipslightbox="" data-ipslightbox-group="undefined"><img src="https://i.ibb.co/875WJqm/inlandcargo2.jpg" alt="spacer.png" width="640" height="359" data-ratio="56.09" data-src="https://i.ibb.co/875WJqm/inlandcargo2.jpg" data-loaded="true" /></a><br /> <br /> To set a static spawn location for cargo incase you lots of islands on the outside of cargoships path or you want it to come down a river first.<br /> Go to that location as a player with the BCargo.admin permission. Then type <strong>/setbcargo</strong> and it will set that as its static spawn location.<br /> Then enable the function within the config json file.<br /> ("Override random cargo spawn point : ": true,)<br /> <br /> If you are using the tides plugin you will have the issue of the cargoship stays at the same height as when it spawned. This means it will sink under water if it spawned at low tide. Or fly in the air if it spawned at high tide.<br /> Enabling this function will allow it to auto reheight as its traveling its path.<br /> ( "Enable auto leveling for tides plugin : ": true,)<br /> <br /> <br /> <strong>Permissions: (Needed for chat commands)</strong><br /> BCargo.admin<br /> <br /> <strong>Chat commands:</strong><br /> /setbcargo = Sets cargoship to spawn to players current location instead of random offshore location.<br /> /reloadbcargo = Reloads the json config file.</p>
<p><strong>BCargo</strong><br /> Blocks Cargoship from leaving while it is within a blocked area.<br /> Allows to set a static spawn position for the cargo to stop it running though islands on its way into the nearest path node or to have it come down a river<br /> Add support for auto leveling of cargo when using tides plugin to stop it sinking below water level or flying in the air.<br /> <br /> <strong>How to use:</strong><br /> Join your server and add some blocking nodes.<br />This is done by typing <strong>/bcargo add</strong><br />It will add a blocking node where your player currently is and with a radius thats been set by LeaveBlockDistance value (default is 120)</p>
<p>You can remove blocking nodes with the command <strong>/bcargo remove 0</strong><br />That will remove the last node placed. Using a number of the node instead of 0 will remove the selected node.<br /><br />You can view the cargos default path by typing <strong>/bcargo view</strong><br />This will show default path nodes as blue and your blocking nodes as red.<br /><br /></p>
<p><img src="https://github.com/bmgjet/BCargo/raw/main/screenshotbcargo.jpg" alt="" width="1440" height="729" /><br /> <br /> <br /> To set a static spawn location for cargo incase you lots of islands on the outside of cargoships path or you want it to come down a river first.<br /> Go to that location as a player with the BCargo.admin permission. Then type <strong>/bcargo spawn</strong> and it will set that as its static spawn location.<br />You can enable/disable use of this manual spawn spots with the command <strong>/bcargo spawn on</strong> or <strong>/bcargo spawn off</strong><br /> <br /> If you are using the tides plugin you will have the issue of the cargoship stays at the same height as when it spawned. This means it will sink under water if it spawned at low tide. Or fly in the air if it spawned at high tide.<br /> Enabling this function will allow it to auto reheight as its traveling its path.<br /> ( "Enable auto leveling for tides plugin : "true,)</p>
<p><span style="text-decoration: underline;">Once you are happy with the node path you have set out for blocking use the command</span><br /><strong>/bcargo save</strong><br />to save all changes you have made.<br /> <br /> <br /> <strong>Permissions: (Needed for chat commands)</strong><br /> BCargo.admin<br /> <br /> <strong>Chat commands:</strong><br />/bcargo help&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; --- Will show a list of commands and there description.</p>