Setup and Configuration
This page will guide you through setting up and configuring the plugin
Setup
- Download the version of the plugin that corresponds to your craftbukkit version. You can find the latest version here.
- Drag the GravityMachine.jar file into your plugins folder. This folder is found by going to wherever your server files are stored, then opening the folder titled "plugins".
- If your server is currently running, you will need to restart it. If not, start up your server and the necessary files will be created within the "plugins" folder in a folder titled "GravityMachine".
- Upon opening the GravityMachine folder, you should see a config.yml file and a folder with the title "Data". For now we will focus on the configuration file.
Configuration
After the plugin has generated the necessary files, there should now be a config.yml file as previously stated in the setup section.
For this section, I will going over each of the variables in this file and explaining exactly what they do.
- usePermissions:
- When this is false, permissions will not be used for the plugin and all players will have access to the features that GravityMachine provides. If you want to use permissions, set this variable to true and use the following permissions nodes for your permissions plugin.
- gravitymachine.use - this node allows players to use machines
- gravitymachine.create - this node allows players to create machines
- gravitymachine.destroy - this node allows players to destroy machines
- gravitymachine.give - this allows the use of the command "/gravity give"
- gravitymachine.use - this node allows players to use machines
- When this is false, permissions will not be used for the plugin and all players will have access to the features that GravityMachine provides. If you want to use permissions, set this variable to true and use the following permissions nodes for your permissions plugin.
- radiusOfLevitation:
- This is the the radius of the sphere of blocks that gravity machines will move. Increasing this number will increase the amount of blocks sent up into the sky, but will also increase the amount of time it takes to process all of them (because there are more of them) so be careful when increasing this number. Alternatively, decreasing this number will decrease the amount of blocks processed as well as the time it takes to move all of the blocks.
- heightOfLevitation:
- This is how high the machine will send all of the blocks up into the air. Increasing or decreasing this number does not change the time taken to process all of the blocks, but merely changes how high the blocks are lifted into the sky.
- blocksProcessed:
- This is an important one. Before increasing this variable, know how much your server can handle. Increasing this number will speed up the entire process of the machines but can also cause lag depending on the capabilities of your server. Alternatively, decreasing this number will slow down the entire process of the machines but will put much less strain on the server.
- machineUses:
- This is how many times a gravity machine can be used before it is deleted. This is entirely up to the server owner to decide how many times they want players to be able to use a specific machine before they have to create a new one.
- gravityMessage:
- This is the message that is displayed when players are sent into space while the machine builds the future sky area around them. You may wish to change this to match a specific theme of your server.
- breakMessage:
- This is the message that is displayed (to the player who turned on the machine) when the machine breaks after it has reached it's maximum number of uses.(See machineUses variable above.)
- This is the message that is displayed (to the player who turned on the machine) when the machine breaks after it has reached it's maximum number of uses.(See machineUses variable above.)
- I hope this guide helped you! If you have any additional questions or comments, feel free to let me know on the main page here. For any issues with the plugin, please Submit a Ticket. Thanks!
Comments