Plugins/Essentials

From Torch Wiki
Jump to: navigation, search


Essentials is a plugin created by the torch team. It has a wide variety of functions. the official version can be downloaded here


Settings[edit]

Client join tweaks[edit]

Checking this box will allow you to customize the client join options below.

Pack Respawn[edit]

This will add any grids a player can respawn at to the world sent to the player, which means the player will not have to wait in the respawn screen until the grid streams in after joining the server. Enabling this will slightly increase the load of a player join and is not recommended if you use the new respawn system.

The "Pack Respawn" option is configurable by block count in the box below it, setting a maximum of blocks that can get packed into the world send.

Loading Text[edit]

This changes the text displayed in the loading screen


Override Default Toolbar[edit]

This will allow you to replace the default toolbar of new players with the one you can choose yourself using the "!admin set toolbar" command while in-game.


Compression level[edit]

This dropdown menu allows you to compress the data you send to players on join, increasing CPU usage while players join but greatly reducing network load, and letting the client join a bit faster.. It's strongly recommended to use the async join option if you set the compression level high.

NoCompression sends the data at its full size. This takes almost no time to run compression, but significantly increases network load.

Fastest is the default vanilla level. It tries to strike a good balance between final data size and CPU use.

Optimal gives you the highest possible compression ratio (smallest data size) at the cost of high CPU use. This is the default value for Essentials. It's recommended to leave this on Optimal level, and enable async join.

Async join[edit]

Checking this option will move most of the client join logic and data compression to a background thread. This reduces lag on the server. It's highly recommended to use this option if you have the compression level set high, or use the pack respawn or pack planets options.

Pack Planets[edit]

This packs planets into the world loading. Since planet data is very large, this is only recommended with optimal compression level.

Having async join enabled is also recommended when using this option.

Packing Planets will greatly decrease of loading time for large planet files when used this way and makes joining a server a lot smoother for the players

Auto Commands[edit]

Runs a pre-programmed command after a given interval of server uptime or scheduled time.

Setup[edit]

Basic options for auto commands.

  • Enabled: Enables / Disables a given command.
  • Interval: The frequency the command will run at. Formatted as HH:MM:SS.
  • OnStart: Triggers once after start using interval duration from startup. (interval must not be 00:00:00 and must be greater than how long the server takes to fully load)
  • SimSpeed: This trigger will run immediately when SimSpeed drops below what you set in "ratio" then checks every "interval"
  • Vote: Triggered only by vote
  • Timed: Triggers every X Minutes/Hours after the server comes online or after the command was created
  • Scheduled: Triggered by "Scheduled" and does a check every set "interval"
  • PlayerCount: Triggered by set number of players then checks every "Interval"
  • GridCount: Triggered by set grid number then checks every "Interval"
  • Name: Command name
  • Add: Add auto command to list.
  • Remove: Removes auto command from list.

Steps[edit]

Pulls up a list of current steps in the collection. Steps can be edited by clicking on them, removed or new steps added. Note, steps must be written in order of operation and can not be reordered.

  • Command: The command to be run. Use torch commands with the same syntax as if they are run within the game. !notify "Restart in 1 minutes" 10000
  • Delay: The delay AFTER the current step and before the next step will run. Formatted as HH:MM:SS.
  • Add: Adds step to collection list.
  • Remove: Removes selected step.

Schedule[edit]

Allows for commands to be run on a fixed schedule.

  • Day of Week: Allows for selection of each day of the week and "All". Does not currently allow for multiple selections.
  • Scheduled Time: The time the auto command will run. Formatted as HH:MM:SS, in 24 hour time "13:00:00" for 1 pm. Time is based on server time. Note: must be set to 00:00:00 for interval-based commands.

Essentials.cfg[edit]

If you have a hosted server without access to the GUI, you can add Auto Commands to your Essentials.Cfg. However, as with all Torch configurations, you should only edit the configuration files as a last resort.

The following code with need to be placed within the <AutoCommands> section of the Essentials.cfg.

  1. <AutoCommands> Denotes the start the Auto Command section. This MUST be ahead of all following code.
  2. <AutoCommand> Denotes the start of a new command.
  3. <Enabled>true</Enabled> Enables the command to run. Replacing "true" with "false" will disable the command.
  4. <Name>Restart</Name> Name of the auto command.
  5. <ScheduledTime>00:00:00</ScheduledTime> The time the auto command will run. Formatted as HH:MM:SS, in 24 hour time "13:00:00" for 1 pm. Time is based on server time. Note: must be set to 00:00:00 for interval-based commands.
  6. <Interval>04:00:00</Interval> The frequency the command will run at. Formatted as HH:MM:SS.
  7. <DayOfWeek>All</DayOfWeek> Allows for selection of each day of the week and "All". Does not currently allow for multiple days of week.
  8. <Steps> Denotes the start of the command steps sections.
  9. <CommandStep> Donotes the start of a new step.
  10. <Delay>00:05:00</Delay> The delay AFTER the current step and before the next step will run. Formatted as HH:MM:SS.
  11. <Command>!notify "Restart in 15 minutes!" 30000</Command> The command to be run. Use torch commands with the same syntax as if they are run within the game.
  12. </CommandStep> Denotes the end of a step. Addtional steps can be added below by repeating code 9-12 below.
  13. </Steps> Denotes the end of the command steps sections.
  14. </AutoCommand> Denotes the end of a the command. Addtional commands can be added by repeating code 2-14 below.
  15. </AutoCommands> Denotes the end the Auto Command section. This MUST be below of all prociding code.

Below is an example of a restart that takes every 4 hours, with notifications every 5 minutes starting 15 minutes prior and clean up commands.


 <AutoCommands>
   <AutoCommand>
     <Enabled>true</Enabled>
     <Name>Restart</Name>
     <ScheduledTime>00:00:00</ScheduledTime>
     <Interval>04:00:00</Interval>
     <DayOfWeek>All</DayOfWeek>
     <Steps>
       <CommandStep>
         <Delay>00:05:00</Delay>
         <Command>!notify "********Restart in 15 minutes!********" 30000</Command>
       </CommandStep>
       <CommandStep>
         <Delay>00:05:00</Delay>
         <Command>!notify "********Restart in 10 Minutes!********" 30000</Command>
       </CommandStep>
       <CommandStep>
         <Delay>00:05:00</Delay>
         <Command>!notify "********Restart in 5 minutes - Find a Pod!********" 30000</Command>
       </CommandStep>
       <CommandStep>
         <Delay>00:00:30</Delay>
         <Command>!notify "********Restart in 1 minutes - END OF THE WORLD IS COMING!********" 30000</Command>
       </CommandStep>
       <CommandStep>
         <Delay>00:00:05</Delay>
         <Command>!cleanup delete nopower</Command>
       </CommandStep>
       <CommandStep>
         <Delay>00:00:05</Delay>
         <Command>!sandbox clean</Command>
       </CommandStep>
       <CommandStep>
         <Delay>00:00:30</Delay>
         <Command>!save</Command>
       </CommandStep>
       <CommandStep>
         <Delay>00:00:00</Delay>
         <Command>!restart 30</Command>
       </CommandStep>
       <CommandStep>
         <Delay>00:00:00</Delay>
       </CommandStep>
     </Steps>
   </AutoCommand>
 </AutoCommands>