bmgjet
/
AutoElevator
mirror of https://github.com/bmgjet/AutoElevator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
bmgjet 2021-09-14 21:51:58 +12:00 committed by GitHub
parent f5730e3aba
commit 0dbe06621a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,6 +1,6 @@
<h1 class=" d-flex flex-wrap flex-items-center wb-break-word f3 text-normal"><strong class="mr-2 flex-self-stretch"><a href="https://github.com/bmgjet/AutoElevator" data-pjax="#js-repo-pjax-container">AutoElevator</a></strong></h1>
<p><strong><span style="text-decoration: underline;">Permission required to change settings:</span></strong><br />AutoElevators.use<br /><br /><strong><span style="text-decoration: underline;">Commands:</span></strong><br />/elevator&nbsp;&nbsp; (Show help menu)<br />/elevator floors X (X number of floors, use negitive numbers to go down instead of up)<br />/elevator return Bool (true or false if you want it to auto return after delay)<br />/elevator delay X (X number of seconds before it auto returns)<br />/elevator speed X (x is float number of speed)<br />/elevator direction X (x is int number of direction selection)<br />/elevator position X|X|X (x is float number of vector3)<br />/elevator reset yes (Clears saved data)<br />/elevator pos get (Prints on screen the players current position)</p>
<p><strong><span style="text-decoration: underline;">Permission required to change settings:</span></strong><br />AutoElevators.use<br /><br /><strong><span style="text-decoration: underline;">Commands:</span></strong><br />/elevator&nbsp;&nbsp; (Show help menu)<br />/elevator floors X (X number of floors, use negitive numbers to go down instead of up)<br />/elevator return Bool (true or false if you want it to auto return after delay)<br />/elevator delay X (X number of seconds before it auto returns)<br />/elevator speed X (X is float number of speed)<br />/elevator direction X (X is int number of direction selection)<br />/elevator position X|X|X (X is float numbers of vector3)<br />/elevator save yes (Saves the data file straight away)<br />/elevator reset yes (Clears saved data)<br />/elevator pos get (Prints on screen the players current Vector position)</p>
<p><br /><span style="text-decoration: underline;"><strong>How To:</strong><br /></span>Place down "Elevator Lift Static" in rust edit where you want them to spawn.<br />Install plugin as usual.<br />Start server and elevators will spawn in those postions with default config of moving 1 floor.<br />Join the server and with the correct permission stand on the elevator and look down.<br />Use commands to adjust its settings.</p>
<p>Settings are persistance across server restarts/wipes.<br />Which is stored in your oxide/data folder as AutoElevators.json</p>
<p>If you are switching maps either delete this file before starting server or from server run /elevator reset yes<br /><br /><span style="text-decoration: underline;"><strong>Using Buttons:</strong></span><br />Place a push button within a 0.8f radius of the travel path of the elevator.<br />It will scan up and down that area to find which elevator to control.<br /><br /><img src="https://github.com/bmgjet/AutoElevator/raw/main/button.jpg" alt="" width="1024" height="760" /><br /><br /></p>
<p><span style="text-decoration: underline;"><strong>Video:</strong></span> <br /><a href="https://www.youtube.com/watch?v=Sbn1lAaUKMk">https://www.youtube.com/watch?v=Sbn1lAaUKMk</a></p>
<p>Settings are persistance across server restarts/wipes.<br />Which is stored in your oxide/data folder as AutoElevators.json<br />The data file is saved on server save hook, plugin unload or by manually calling it with chat command /elevator save yes</p>
<p>If you are switching maps either delete this file before starting server or from server run /elevator reset yes<br /><br /><span style="text-decoration: underline;"><strong>Video:</strong></span> <br /><a href="https://www.youtube.com/watch?v=Sbn1lAaUKMk">https://www.youtube.com/watch?v=Sbn1lAaUKMk</a><br /><br /><span style="text-decoration: underline;"><strong>Using Buttons:</strong></span><br />Place a push button within a 0.8f radius of the travel path of the elevator.<br />It will scan up and down that area to find which elevator to control.<br /><br /><img src="https://github.com/bmgjet/AutoElevator/raw/main/button.jpg" alt="" width="1024" height="760" /><br /><br /></p>
<p><strong>Directions:</strong><br />You can do more than just go up and down.<br />Using the /elevator direction 0-7 command.<br />You have<br />Setting 0 (Up and down)<br />Setting 1 (Forward and backwards<br />Setting 2 (Side to side)<br />Setting 3 (Got to vector address)<br />Setting 4 (Rotate on X axis)<br />Setting 5 (Rotate on Y axis)<br />Setting 6 (Rotate on Z axis)<br />Setting 7 (Go up and 180 rotate)<br /><br /><span style="text-decoration: underline;"><em>Example of Rotation in action:</em></span><br /><a href="https://www.youtube.com/watch?v=5gg5_D-XbME">https://www.youtube.com/watch?v=5gg5_D-XbME</a></p>