Config

Screenshot of the Config

All configurations for the Tool to work can be set here. Each time you change your config, it is advisable to restart the tool. Some main settings are only activated after a restart of the tool. Most of the configuration is taken automatically out of the dedicated.yaml file. Therefore its imporstant to set the settings for the dedicated.yaml file first.

HINT: Many hints are shown in the Tool-Tips when hoovering over the fields. Path will be shown Orange/Green depending on if its correct or still missing/wrong.

Setup

Server (Lite)

IP-Adress or name of your server. This is important for the telnet connection and therefore only for the lite version.

Overwrite Telnet IP (Lite)

If your server has a different telnet ip, please enter it here. If not you can leave it empty. This is needed for Nitrado for example!

Game Directory

Path to the Empyrion directory where the executable and dedicated.yaml is located. When FTP is activated, this is the directory from your FTP entry point to the Game directory (there needs to be at least one folder inbetween). Example: "C:\Program Files (x86)\Steam\steamapps\common\Empyrion - Galactic Survival\" or ftp: "Empyrion - Galactic Survival/" If you set up the Slave tool, this setting should be empty and is not needed.

Dedicated.yaml filename

Name of the Dedicated.yaml file. If you set up the Slave tool, this setting should be empty and is not needed.

Use Dedicated.cmd

If unchecked the tool will start the game without considering the dedicated.cmd.

Dedicated.cmd filename

Name of the Dedicated.cmd file to start the server. If you set up the Slave tool, this setting should be empty and is not needed.

Creative Game Player Directory

Path to the 'Player' folder of your local Creative Game. Only important if you want to use the function 'Copy player to creative' Example: "C:\Program Files (x86)\Steam\steamapps\common\Empyrion - Galactic Survival\Saves\Games\Creative\Players" If you set up the Slave tool, this setting should be empty and is not needed.

Own Player ID

Your own Player ID (Steam-ID). Used to move the player to creative game or for impersonation

Telnet Port (Lite)

Telnet Server Port (Read-Only). Its taken out of the dedicated.yaml file. Its only for the lite tool.

Backup Directory

Path to the Backup folder (The standard is "Game Directory\"Backups"). If you set up the Slave tool, this setting should be empty and is not needed.

Master Config Directory

If set, this tool wil only save his own config and loads all other configurations automatically from the Master-Tool. If you want to use it, please enter here the 'Config\'-Folder of the Master tool. If you set up the Slave tool, you can use this setting additonal to the Sync-Tpye Slave to be able to use the DB of the Master and have a Sync-Connection. This makes only sence if the Slave and master are on the same server.

Admin Name (Full)

Name of the Admin using this tool. Its good to see who wrote the Chat in case you have multiple Amdins using each one his own tool. Works only for Sync.

Game Version

Depending on the Game Version you are running you need to set this value. If the current version is not listet, use the latest version. This means there were no major changes that affect the tool.

Translation

Choose a language the chat should be translated to. 64 languages available.

Keep backup for (days)

Days how long backups should be kept

Keep big data for (days)

Days how long logs and statistics should be kept. Statistics and Player-activity are kept the double amount of days. Attack-Logs -1 day.

API IP

Server Name or IP for the API. This should be 127.0.0.1

API Port

Port for the API

Allow to edit (Full)

If you are not sure if the current version of the tool is compatible to the game-version or you notice strange data in the list or inventory, set this check-box. This way no game-data will be changed to prevent corruption (The tool has an automated detection if the game is incompatible to the tool. This is just in case).

GUI

Determins if the tool runs with a GUI or without. Dont change it. This is for Server Hoster.

Play sound for Chat Alerts

If a Chat Alert comes up (Yellow marked in Chat) a sound will be played

Master/Slace Sync

If off you are using just one tool. If Master this is your main tool on the server and other tools are connected via Slave

Sync IP

Server Name or IP for the Synchronisation

Sync Port

Port for the Synchronisation

Sync Password

Password for the Synchronisation

Starter Service Port

In case you run the Starter-Service on the Server (to be able to start the tool from remote) you can set here the port. Password and IP are taken fomr the Sync.

Fresh Start

Clears all old values to start a new game (factions, inventory, health, statistics, logs, structures, etc...). You cna select which to clear.

Reset red counter

Resets the red counter which marks player who were again and again flagged as possible high cheater. If they were flagged often enough they will stay as possible high cheater. With this button you can reset it and clear all player from such flags.

Check Database

From time to time (like a wipe) this might be a good option to shrink your databases. (The database will grow after some time even though data is deleted).

FTP (Lite)

FTP Port

FTP Server Port (only when ftp is active)

FTP User (Lite)

FTP User (only when ftp is active)

FTP Old (Lite)

If FTP does not work, try this option.

FTP Type (Lite)

Active / Passive / SFTP

FTP Repeat (Lite) (Set manual in Settings.xml)

How often he should try to repeat to download/upload a file after an error occured

FTP Timeout (Lite) (Set manual in Settings.xml)

Timout to connect ot the FTP Server and perform tasks

FTP Active (Lite)

Set FTP active/inactive. After setting FTP to active the FTP-Fields will be editable. If you activate FTP, polease make sure to enter the "Automatic Load" function in the Timetable, maybe every 5 minutes. This way every 5 minutes the Information will be updated.

Refresh from FTP (Lite)

Downloads the dedicated.yaml file to load the current settings. (only when ftp is active)

FTP Password (Lite)

Set the FTP password. (only when ftp is active)

Features

New Player Welcome Message

Set the Message a new player should get when he starts fresh on the server

Chat Alerts

Set your own keywords, that should be highlighted as alerts in the chat. Split each keyword with #

Auto Ban (Full)

If checked the tool will automaticaly ban cheaters that are confirmed due to their inventory, health, blueprint-factory, etc....

ChatBot

Activates the Chatbot

Combat log (Full)

If checked the intruder log will be filled, showing possible intruders and attacks.

Coordinate log (Full)

If checked the coordinate log will be filled, showing every movement of player and structures.

Structure limit control (Full)

Activates the automated control of structure limits and block limits, that you can set in the playfield list

Structure control Block/Device execution (Full)

Activates the taking of a ship to a certain faction, if the owner does not obey your limits.

Structure-Control: Set to Faction (Full)

Determins the faction (shortcut), to be used if someone does not obey your structure control rules. Ships would be set to that faction

Swear filter

Activates the Swear filter (Bans people for 2 hours increasing if they use to much bad language)

Swear filter only in Global

Activates the Swear filter only in global chat. People can write what they want in faction chat.

Warning until ban

Determins after how many automatic warnings (for ex. due to the swear filter) the player should be banned ofr some time.

Increas ban-hours

Determins the amount of hours to increase after each automatic ban. So if set to two, the first time he will be banned for 2 hours, next time for 4 hours, ...

Conditional swear-words

Set your own words seperated by #. Player that use those

Survival Money (Full)

How much Credits should each player get after each full wipe of the server (fresh start)

Reset CB:Survival on CB:Reset (Full)

If checked resets the CB:Survival date for the player, allowing him to use CB:Survival again. Carefull this could be exploited for a few times.

Chatbot Commands (in seconds)

How long does a player have to wait until he can type another intensive chatbot command like am:get:all

Wait for answer timeout

How often should the mod wait (each time 5-80 ms) for an answer. Be careful changing this value. Default is 50

Worker-Thread pause (in ticks)

How long should the Worker-Thread wait before going through the next jobs. Be very careful with changing this value. Default is 50

API Check (in minuts)

How often should API be checked. Default is 1

Autosave (in minutes)

How often should the tool-data be saved. Default is 30

Dedicated Statistics (in minutes)

How often should Dedicated-Server statistics be made. Default is 10

Playfield Statistics (in minutes)

How often should Playfield statistics be made. Default is 30

Player reload (in seconds)

How often should the online-players be reloaded. Default is 30

Structure reload (in minutes)

How often should structures of online playfields be reloaded. Default is 2

Set structures public if not touched (hours)

Activated if > 0. Set the amount of hours after which every player structure that was not touched will be set to public.

Autominer

Activate and Set up your Autominer. The Auto Miner is taking care of your automatic Ore production so you don't have to mine it yourself. Especially designed for the lategame.

  • Activate Autominer
  • Activate AM:Info --> To allow users to type AM:Info and see their current AM Information

Auto Miner Commands

  • am:? Provides you with useful information regarding the Auto Miner.
  • am:info Displays your current fuel level and shows your current miner levels and resources.
  • am:buy:AM-Ore AM-Ore stands for one of the 11 available Ores you can have. (e.g. am:buy:iron). Allows you to purchase and upgrade Auto Miners. To upgrade a current Auto Miner, simply type the buy command for it again and make sure you have enough credits in your bank account to buy it.
  • am:sell:AM-Ore Allows you to sell or downgrade your current Auto Miners.
  • am:get:AM-Ore:Amount Allows you to recover a specific amount of one of your mined resources.
  • am:get:all Allows you to recover all mined resources at once. (Make sure you have inventory space).
  • am:Fuel:Item/All:Amount/All Sends a certain amount of fuelto the Auto-Miner. 'Item' can be 'ALL' to fuel all autominer. 'Amount' can be 'ALL' to use all fuel in inventory. Example: AM:Fuel:Go:All or AM:Fuel:All:10 or AM:Fuel:All:All

Auto Miner Price (AM upgrade price)

This is the price player need to pay to get Auto Miner.

Keep in mind that level 1 is free for everyone.

Than the math is easy:

the price you set multiplied by the level

Example: if you set 1000 then it would mean it cost 2000 at level 2, 3000 at level 3 and so on.

Same for selling.

Auto Miner Production / Rare ore division

If you insert 3 in the "AM rare ore division" field it would mean the rare ores are 1/3 from the normal ones.

The default list shows you how much you gain per Auto Miner level in brackets you see the example of 1/3 rare ores:

  • Upgrade level 1 - 5 (1 Gold/Sahtium/Neodymium/Blue Crystal) / hour
  • Upgrade level 2 - 10 (3 Gold/Sahtium/Neodymium/Blue Crystal) / hour
  • Upgrade level 3 - 15 (5 Gold/Sahtium/Neodymium/Blue Crystal) / hour
  • Upgrade level 4 - 20 (7 Gold/Sahtium/Neodymium/Blue Crystal) / hour
  • Upgrade level 5 - 30 (10 Gold/Sahtium/Neodymium/Blue Crystal) / hour
  • Upgrade level 6 - 35 (11 Gold/Sahtium/Neodymium/Blue Crystal) / hour
  • Upgrade level 7 - 40 (13 Gold/Sahtium/Neodymium/Blue Crystal) / hour
  • Upgrade level 8 - 50 (16 Gold/Sahtium/Neodymium/Blue Crystal) / hour
  • Upgrade level 9 - 100 (33 Gold/Sahtium/Neodymium/Blue Crystal) / hour
  • Upgrade level 10 - 150 (50 Gold/Sahtium/Neodymium/Blue Crystal) / hour

Auto Miner available resources

In the AddOn window you can set your desired Auto Miners.

Commands would be the following ingame:

  • am:buy:IR = Buy or Upgrade an Auto Miner Iron Ore
  • am:buy:COP = Buy or Upgrade an Auto Miner Copper Ore
  • am:buy:COB = Buy or Upgrade an Auto Miner Cobalt Ore
  • am:buy:MA = Buy or Upgrade an Auto Miner Magnesium Ore
  • am:buy:PR = Buy or Upgrade an Auto Miner Promethium Ore
  • am:buy:NEO = Buy or Upgrade an Auto Miner Neodynium Ore
  • am:buy:SI = Buy or Upgrade an Auto Miner Silicion Ore
  • am:buy:SA = Buy or Upgrade an Auto Miner Sathium Ore
  • am:buy:GO = Buy or Upgrade an Auto Miner Gold Ore
  • am:buy:ER = Buy or Upgrade an Auto Miner Erestrum Ore
  • am:buy:ZA = Buy or Upgrade an Auto Miner Zascosium Ore
  • am:buy:BC = Buy or Upgrade an Auto Miner Blue Crystal

We have internally set some ores to rare:

  • Erestrum
  • Zascosium
  • Neodymium
  • Gold
  • Blue Crystal

Every other ore is counted as "normal".

Auto Miner Cargo

That list shows you how much Ores the Auto Miner can maximum store per level:

  • Upgrade level 1 - 300 Max Ores
  • Upgrade level 2 - 600 Max Ores
  • Upgrade level 3 - 750 Max Ores
  • Upgrade level 4 - 1200 Max Ores
  • Upgrade level 5 - 1650 Max Ores
  • Upgrade level 6 - 1950 Max Ores
  • Upgrade level 7 - 2400 Max Ores
  • Upgrade level 8 - 3000 Max Ores
  • Upgrade level 9 - 6000 Max Ores
  • Upgrade level 10 - 9000 Max Ores

Auto Miner Mining

  • Mine every x minutes --> Set how often the autominer should run
  • Consume fuel every x minutes --> Set how often the autominer should use fuel
  • Consume x fuel per level/AM --> Set how much fuel should be taken
  • Fuel Item --> Set the Item ID (see Item-List) of the Item that should be used as fuel
  • All level cost same fuel --> If set each level will use the same amount of fuel. If not set the fuel will multiply by the level.

Auto Miner Fuel

Your Auto Miner needs Drill Charges as fuel to be running. They mining non stop, Day and Night, 24/7, even if you are offline - as long as they have fuel (Drill Charges) Type am:fuel:x (where x is the amount how much Drill Charges you want to insert) to fuel up your auto miners. These are following prices:

  • Upgrade level 1 - 1 Drill Charges / day / auto miner
  • Upgrade level 2 - 2 Drill Charges / day / auto miner
  • Upgrade level 3 - 3 Drill Charges / day / auto miner
  • Upgrade level 4 - 4 Drill Charges / day / auto miner
  • Upgrade level 5 - 5 Drill Charges / day / auto miner
  • Upgrade level 6 - 6 Drill Charges / day / auto miner
  • Upgrade level 7 - 7 Drill Charges / day / auto miner
  • Upgrade level 8 - 8 Drill Charges / day / auto miner
  • Upgrade level 9 - 9 Drill Charges / day / auto miner
  • Upgrade level 10 - 10 Drill Charges / day / auto miner

Example: An Iron Ore Auto Miner at level 7 and a Gold Ore Auto Miner at level 2 costs you 9 Drill Charge per day in total and would cost you 290k CR to get them if you set the rare ore division to 1/3.

Keep in mind that you have to restart the tool after activation!

Bug fixes

Public-Structure-Bug protection

this captures the bug that all or many structures in a playfield are set to public. If checked the tool will set all those structures back to its original owner

Protection kick in after structures

This one determins after how many public structures the protection should kick in. Keep in mind that setting a few structures to public might be no bug.

Emergency Warp

Activates the Emergency Warp. Warps a player automatically out of pole/green barrier when he is in there for more then 2 minutes.

Emergency Warp on login

Warps a player who cant login (due to crashed playfield) to his starter-planet or another pve planet.

Pole Control Warp

Enables the automatic warp of players in pole

Ship Pole Control Warp (Full)

Enables the automatic warp of ships in pole

Failed Pole Warp Destruction

Some structures cant be warped out of the pole since they seem to be buggy. To prevent furhter game problems this option deletes those structures after several attempts.

Failed Pole Warp until destroy

The number of attempts he should make to warp the structure out o pole.

Activate Profiling / when CPU reades

Activates the game profiling when the CPU reaches a certain level. Only use this when asked by Game-Devs

Activate CPU Autorestart / when CPU reades

Restarts the game if the CPU spiles to a certain CPU-Level. This might be an option for server that are usually not on high CPU, but have the bug that the CPU goes up suddenly and never goes down.

Telnet-Flood Restart (Lite) / Amount

Restart the tool if a telnet-flood occurs (amount of bug messages) which would otherwise crash your server

Detailed Logs

Logs more data for debugging the tool or finding problems

Item Exchange Logs

Logs all Item movment of players

Connection Logs

Logs all connections and transfered commands.