Server Configuration: Difference between revisions

[unchecked revision]

[checked revision]

Latest revision as of 00:58, 16 January 2026

Server Configuration can be done either through the /serverui admin command or by directly editing configuration files. Many aspects of the world, items, and player settings can be changed in this way.

Server Folder Breakdown

Configs — Files in this folder contain the configurable settings for the server. You can edit any of the .eco files with a text editor but be careful doing so. Keep in mind none of your edits here will take effect unless you restart your game server.
Logs — This folder will appear once something is logged and will contain log files containing details of what happens when the server is executing.
Dump — Contains crash dump files for when the server crashes.
Mods — Contains server game data. This is also the folder where you should place any mods you want to be installed on the server. Any changes here require a server restart to take effect.
Storage — This is where your world and backups are stored. If you want to wipe a world, just delete this folder.
Web Client — The web server files are found here.

Eco Server UI

The server UI provides access to a wide variety of configuration options. Changes made to config options in the UI will apply to the server without needing to restart the server. However, with any changes you make (such as adding an admin), you must click "File" and "Save" or else you will lose the changes upon reloading the server.

Commands

See Chat Commands for a complete list of commands that are available to both admins and regular users.

Basic Configuration

When setting up a server using the 'Host a World' option in the main menu, it is possible to configure a world using only a few options. They map to the Difficulty.eco configuration file.

Editing Config Files (advanced)

Editing config files can allow for more detailed changes. You can alter world generation and gameplay in many ways.

The configuration present in the files can generally be accessed using the /serverui command in-game (you must be authorized to use admin commands in Users.eco).

Before You Begin

Note that each file has a "template" version. Keep this as a backup of the default values and create a version without the '.template' extension; this will be the real configuration file. Also note that game updates frequently change these settings and may plow over your configuration.

Configuration Notes

Edits to WorldGenerator.eco require a server wipe to take effect.
Whitelisting allows whitelisted players to ignore the requirement for a password but for whitelisting to work you must set a password.
When changing the map size keep the map values divisible by 4 or risk severe issues.
When setting up whitelists/admins you must use either an SLG id or Steam64 id, just writing the username does not work. Here is a link to find your steam64id: http://www.steam64.com
Any changes made to these configuration files will require a server restart before they will take effect.

List of Configuration Files


Config file name	UI Path
Backup.eco	Initial Setup -> Backup
Balance.eco	Gameplay -> Balance
Civics.eco	Gameplay -> Civics
DevSection.eco	None
Difficulty.eco	Gameplay -> Difficulty Settings
Disasters.eco	Gameplay -> Disasters
EcoSim.eco	Sim -> Simulation
Exhaustion.eco	Gameplay -> Exhaustion
Features.eco	Gameplay -> Features
Holiday.eco	Gameplay -> Holiday Manager
Initial Spawn.eco	Gameplay -> Initial Spawn
Localization.eco	System -> Localizer
Maintenance.eco	Initial Setup -> Maintenance
Memory.eco	Dev -> Memory Manager
ModKit.eco	Mods -> ModKit
Network.eco	Initial Setup -> Network
Pause.eco	Gameplay -> Pause
Performance.eco	System -> Performance
Profanity.eco	None
Reputation.eco	Gameplay -> Reputation
Rooms.eco	Gameplay -> Rooms
Settlements.eco	Gameplay -> Settlements
Sleep.eco	Gameplay -> Sleep
SpeciesLayeredCatch.eco	Gameplay -> Species Catcher
Stats.eco	System -> Stats
Storage.eco	Initial Setup -> Storage
StrangeWorlds.eco	Initial Setup -> Strange Cloud
Twitch.eco	Gameplay -> Twitch
Users.eco	Initial Setup -> Users
UserTextures.eco	Gameplay -> User Textures
Voice.eco	Gameplay -> Voice
Weather.eco	Gameplay -> Weather
World.eco	Sim -> World
WorldGenerator.eco	Sim -> World Generator
WorldObjects.eco	Game Status -> World Objects

@@ Line 1: / Line 1: @@
-[[Server Configuration]] can be done either through the server GUI or by directly editing configuration files. The latter option is only recommended for advanced users. Many aspects of the world, items, and player settings can be changed in this way.
+[[Category:Server Management]]
+__NOTOC__
+[[Server Configuration]] can be done either through the <code>/serverui</code> [[Chat Commands#Admin Commands|admin command]] or by directly editing configuration files. Many aspects of the world, items, and player settings can be changed in this way.
-''This configuration guide is based on player tests and crowd-sourcing. No information in this guide has been confirmed by [[SLG]].''
+== Server Folder Breakdown ==
+* '''Configs''' — Files in this folder contain the configurable settings for the server. You can edit any of the .eco files with a text editor but be careful doing so. Keep in mind none of your edits here will take effect unless you restart your game server.
+* '''Logs''' — This folder will appear once something is logged and will contain log files containing details of what happens when the server is executing.
+* '''Dump''' — Contains crash dump files for when the server crashes.
+* '''Mods''' — Contains server game data. This is also the folder where you should place any mods you want to be installed on the server. Any changes here require a server restart to take effect.
+* '''Storage''' — This is where your world and backups are stored. If you want to wipe a world, just delete this folder.
+* '''Web Client''' — The web server files are found here.
-== Basic server configuration ==
+== Eco Server UI ==
+The server UI provides access to a wide variety of configuration options. Changes made to config options in the UI will apply to the server without needing to restart the server. However, with any changes you make (such as adding an admin), you must click "'''File'''" and "'''Save'''" or else you will lose the changes upon reloading the server.
-[[File:ServerConfig_Example.jpg|300px|thumb|Setting a server's public status to "True" and adding a server description, both done in the Config tab of the Network plugin.]]
+== Commands ==
+See [[Chat Commands]] for a complete list of commands that are available to both admins and regular users.
-The most common and important server configurations can be made through the server GUI. Each tab in the server window will have at least 1 sub-tab. Usually, there will be at least 2 sub-tabs: Display and Config. The Display tab shows relevant information and stats about that plugin (each tab represents a server plugin).
+== Basic Configuration ==
+When setting up a server using the 'Host a World' option in the main menu, it is possible to configure a world using only a few options. They map to the [[Server Configuration/Difficulty.eco|Difficulty.eco]] configuration file.
+== Editing Config Files (advanced) ==
+Editing config files can allow for more detailed changes. You can alter world generation and gameplay in many ways.
-Opening the Config tab in each plugin will present a list of options that can be changed through drop-down menus or collections (look for the arrow or breadcrumbs on the right) or direct data entry.
+The configuration present in the files can generally be accessed using the <code>/serverui</code> command in-game (you must be authorized to use [[Chat Commands#Admin Commands|admin commands]] in [[Server Configuration/Users.eco|Users.eco]]).
+=== Before You Begin ===
+Note that each file has a "template" version. Keep this as a backup of the default values and create a version without the '.template' extension; this will be the real configuration file. Also note that game updates frequently change these settings and may plow over your configuration.
-=== Common configurations ===
+=== Configuration Notes ===
+# Edits to WorldGenerator.eco require a server wipe to take effect.
-Below is a guide to the most commonly configured settings that can be changed through the server GUI.
+# Whitelisting allows whitelisted players to ignore the requirement for a password but for whitelisting to work you must set a password.
+# When changing the map size keep the map values divisible by 4 or risk severe issues.
-==== Server Listing Settings ====
+# When setting up whitelists/admins you must use either an SLG id or Steam64 id, just writing the username does not work. Here is a link to find your steam64id: [http://www.steam64.com/ http://www.steam64.com]
+# Any changes made to these configuration files will require a server restart before they will take effect.
-Network > Config
+=== List of Configuration Files ===
+{| class="wikitable sortable content-size"
-===== Make server public/private =====
+|+
+! Config file name
-* Public Server — Set to True to have the server listed in the Eco client [[server browser]].
+!UI Path
+|-
-===== Set playtime table =====
+| [[Server Configuration/Backup.eco|Backup.eco]]
+| Initial Setup -> Backup
-* Playtime — This is automatically filled in if you created the server in the Eco client and made a [[Timetable]] (schedule of preferred playtimes). If this is blank, the best way to fill it in is to “Set Playtime” through the Game Menu ({{Key|Esc}}), and copy and paste the data from playtime.eco. On Windows 10, this file will be found at Users > [username] > AppData > LocalLow > StrangeLoopGames > Eco. Adding a timetable helps the server show up more prominently in the server browser.
+|-
+|[[Server Configuration/Balance.eco|Balance.eco]]
-===== Set server Discord =====
+|Gameplay -> Balance
+|-
-* Discord Address — Adding the unique ID of a Discord server (after the “discord.gg/”) will provide a link to the Discord server from the tutorial.
+|[[Server Configuration/Civics.eco|Civics.eco]]
+|Gameplay -> Civics
-===== Set server password =====
+|-
+|[[Server Configuration/DevSection.eco|DevSection.eco]]
-* Password — Set a password for the server, or leave this blank to not require a password. Players on the whitelist will not have to enter a password.
+|None
+|-
-===== Set server name =====
+| [[Server Configuration/Difficulty.eco|Difficulty.eco]]
+| Gameplay -> Difficulty Settings
-* Description — Sets the name of your server in the client server browser. [[Text markup]] can be used to add color or modify the appearance of the text.
+|-
+| [[Server Configuration/Disasters.eco|Disasters.eco]]
-===== Set server description =====
+| Gameplay -> Disasters
+|-
-* DetailedDescription — Sets the long-form description of your server when people click on it in the server browser. Adding this description helps the server show up more prominently in the browser.
+|[[Server Configuration/EcoSim.eco|EcoSim.eco]]
+|Sim -> Simulation
-===== Set server category =====
+|-
+|[[Server Configuration/Exhaustion.eco|Exhaustion.eco]]
-* ServerCategory — Choose from 1 of 4 categories that will show up when players first click on “New Game” in the Eco client. Selecting a category makes it much more likely new players will join your server.
+|Gameplay -> Exhaustion
+|-
-==== Sleep Settings ====
+|[[Server Configuration/Features.eco|Features.eco]]
+|Gameplay -> Features
-Sleep > Config
-* Allow Fast Forward — Enable or disable sleep. This defaults to “False” on public servers and “True” on local servers. Enabling sleep is not recommended on larger servers or public servers. Use it at your own risk.
-* Sleep Time Pass Multiplier — Maximum multiplier applied to time while sleeping
-* Time to Reach Maximum Time Rate — Time it takes to reach Sleep Time Pass Multiplier
-==== XP/Specialty Progression Speed ====
-Difficulty Settings > Config
-* CollaborationPreset — Change [[collaboration]] settings to adjust how quickly players gain skill points. Sticking with the collaboration presets is recommended.
-* Unlearn Refund Rate — Obsolete as of Beta 8.0. Has no effect.
-* Specialty Cost Multiplier — Obsolete as of Beta 8.0. Has no effect.
-* SpecialtyExperienceDivisor — Reduces experience rate based on number of specialties learned. Effect of this is unclear. May have no effect as of Beta 8.0.1.
-* SpecialtyExperiencePerLevel — Experience required to level up each specialty tier.
-* ExperiencePerAction — Grants player XP based on any player action. Experimental and not recommended for public servers. Modify this setting at your own risk.
-==== Meteor Settings ====
-Disasters > Config
-* Create Meteor — Enable or disable meteor. Changing from True to False while world is running will destroy the meteor. Changing from False to True while world is running will have disastrous consequences. If you wish to enable the meteor, regenerate the world first.
-* Meteor Impact Days — Number of real-life days until meteor makes impact, counting from the date/time the server was first started. To time the meteor impact precisely decimal points seem to be allowed (thus allowing you to align the meteor impact to a desired hour/minute). Editing this setting may require server restart or regeneration to take effect.
-==== User Settings ====
-Users > Config
-* Require Authentication — True/False. Validates users with Eco servers. Set to True by default. False has unknown effects and is not recommended.
-* Allow Debug Calls — True/False. Allows debug calls to be made to the webserver. Unknown effect.
-* White List  — Whitelist selected players. Enter each individual player ID. Press Enter/Return between each ID.
-* Black List — Blacklist selected players. Enter each individual player ID. Press Enter/Return between each ID.
-* Admins — Give selected players ''full'' admin rights. Enter each individual player ID. Press Enter/Return between each ID. Having an admin online helps the server show up more prominently in the server browser.
-''Note:'' Whitelist, Blacklist, and Admins all use player IDs. Use the <code>/whois</code> command to see their ID. You will need to enter the proper ID when editing these lists manually.
-Use the SLG ID unless the user is a Steam-only user.
-{|class="wikitable"
-| SLG only account || use SLG ID
 |-
-| Steam only account || use STEAMID64
+|[[Server Configuration/Holiday.eco|Holiday.eco]]
+|Gameplay -> Holiday Manager
 |-
-| SLG + Steam linked account || use SLG ID
+| [[Server Configuration/Initial Spawn.eco|Initial Spawn.eco]]
-|}
+| Gameplay -> Initial Spawn
-You are able to use the player's name when running the corresponding commands from inside the game.
-* Reputations — Manage [[reputation]] tiers and change their titles (this can be fun on a themed server!).
-* Unstuck Disable Time — Sets (in seconds) the <code>/unstuck</code> cooldown to prevent exploits.
-* <code>AdminCommandsLoggingLevel</code> — Sets the level of logging that happens when an admin invokes admin commands. There are four different levels:
-** <code>None</code> — No logging and no notification is given.
-** <code>LogFile</code> — Log to file.
-** <code>LogFileAndNotifyAdmins</code> — Log to file and notifies the all admins connected to the server.
-** <code>LogFileAndNotifyEveryone</code> — Log to file and notifies the all users connected to the server.
-* <code>UseExactSpawnLocation</code> — Toggles rather exact spawn location should be used for new players, or if the spawn location should be automatically changed dynamically to where there is wild food to gather. Default set to false.
-==== World Generation Settings ====
-WorldGenerator > Config
-''Note:'' Settings that affect world size, shape, and contents will not take effect until the world is re-generated)
-===== Change World Seed =====
-* Seed — Change the randomly generated seed that the world generation is based off.
-''Note'': If you want to duplicate a world off of a seed, you need to match the WorldGenerator.eco settings for that world. This is easy if you just replace your WorldGenerator.eco with a copy of the file from the generated server (the file must have been unchanged since the server was generated). All the random values are generated off the seed, but within ranges defined by the config, so you need both if you want the same end result.
-===== Change World Size =====
-* Dimensions — Changes the size of the world. The X and Y values ''must'' be the same and divisible by 4. However, not all worlds with dimensions that follow these rules will be stable.
-NOTE: The server (EcoServer32.exe) that is bundled with the Eco game client can only run worlds up to 100x100. To run larger worlds, the server must be downloaded separately, through Steam or the SLG website.
-Below are the current recommendations for world sizes. Worlds built outside these recommendations may experience playability, performance, and stability issues that are outside the capabilities of SLG support staff:
-* (72,72) — 0.52km<sup>2</sup> — This is the default size for when first launching the Eco server.
-* (100,100) — 1km<sup>2</sup> — Maximum size for EcoServer32.exe
-* (140,140) — 1.96km<sup>2</sup>
-* (172,172) — 2.96km<sup>2</sup>
-* (200,200) — 4km<sup>2</sup>
-The following worlds have been tested for 50 hours and are likely to be stable. They are, however, only suitable for powerful servers.
-* (224,224) — 5.02km<sup>2</sup>
-* (240,240) — 5.76km<sup>2</sup>
-* (248,248) — 6.15km<sup>2</sup>
-* (272,272) — 7.4km<sup>2</sup>
-* (296,296) — 8.76km<sup>2</sup>
-* (300,300) — 9km<sup>2</sup>
-* (360,360) — 12.6km<sup>2</sup>
-* (400,400) — 16km<sup>2</sup>
-Worlds over 400x400 may be possible to generate, but are very likely to be unstable.
-===== Change World Shape =====
-* WaterLevel — Sea level height.
-* Height — Maximum height of terrain.
-===== Player Spawn Location =====
-* Spawn Location — Set new player spawn location coordinates.
-* Use Exact Spawn Location — Set to True to spawn players at exactly the same coordinates. Defaults to False, which spawns players in a flat area nearby.
-== Editing config files (advanced) ==
-Editing config files can allow for more detailed changes. You can alter world generation, potentially drastically, in many ways. Player starting items can be added or removed. Objects can be edited and have their storage space changed.
-=== Before you begin editing ===
-Before making any changes, make sure you create backups for each configuration file. You should save copies of your edited config files as well, because patches can overwrite your changes.
-To make changing the files easier, consider using an editor like Notepad++.
-When [[Updating a Server|updating]] a server, you will want to manually edit the new config files with all your edits, so make sure you document every config change. You can use a text comparison tool to find differences in configs if you are unsure about changes.
-Some changes require additional steps to take effect as intended:
-* Changes in the area of world generation require a complete restart of the world.
-* Changes in EcoSim.eco are accepted when the server is restarted. However, the new values will only occur in newly planted / grown plants and trees.
-* Changes in the full range of mods require the deletion of "Eco.Mods.dll" to take effect.
-''Note:'' This configuration guide is based on player tests and crowd-sourcing. No information in this guide has not been confirmed by [[SLG]].
-=== List of configuration files ===
-The standard configuration files are located in ''Eco\Eco_Data\Server\configs''
-Many of the settings found within these files can also be edited through the server GUI. Generally, each configuration file has a tab in the server GUI that corresponds to it. Clicking on each particular setting in the GUI will explain what the setting does at the bottom of the window.
-{{contentneeded}}
-==== Backup.eco ====
-==== Difficulty.eco ====
-'''No Collaboration (0-3 players)'''
-{| class="wikitable"
 |-
-| Player Experience Per Specialty Experience || 0
+|[[Server Configuration/Localization.eco|Localization.eco]]
+|System -> Localizer
 |-
-| Skill Gain Multiplier || 5
+|[[Server Configuration/Maintenance.eco|Maintenance.eco]]
+|Initial Setup -> Maintenance
 |-
-| Specialty Cost Multiplier || 0.1
+|[[Server Configuration/Memory.eco|Memory.eco]]
+|Dev -> Memory Manager
 |-
-| Specialty Experience Divisor || 20
+| [[Server Configuration/ModKit.eco|ModKit.eco]]
+| Mods -> ModKit
 |-
-| Specialty Experience Per Level || 25
+|[[Server Configuration/Network.eco|Network.eco]]
+|Initial Setup -> Network
 |-
-| Unlearn Refund Rate || 0.5
+|[[Server Configuration/Pause.eco|Pause.eco]]
-|}
+|Gameplay -> Pause
-'''Low Collaboration (3-10 players)'''
-{| class="wikitable"
 |-
-| Player Experience Per Specialty Experience || 0
+|[[Server Configuration/Performance.eco|Performance.eco]]
+|System -> Performance
 |-
-| Skill Gain Multiplier || 2
+| [[Server Configuration/Profanity.eco|Profanity.eco]]
+| None
 |-
-| Specialty Cost Multiplier || 0.5
+|[[Server Configuration/Reputation.eco|Reputation.eco]]
+|Gameplay -> Reputation
 |-
-| Specialty Experience Divisor || 20
+|[[Server Configuration/Rooms.eco|Rooms.eco]]
+|Gameplay -> Rooms
 |-
-| Specialty Experience Per Level || 25
+|[[Server Configuration/Settlements.eco|Settlements.eco]]
+|Gameplay -> Settlements
 |-
-| Unlearn Refund Rate || 0.5
+| [[Server Configuration/Sleep.eco|Sleep.eco]]
-|}
+| Gameplay -> Sleep
-'''Medium Collaboration (10-30 players)'''
-{| class="wikitable"
 |-
-| Player Experience Per Specialty Experience || 0
+|[[Server Configuration/SpeciesLayeredCatch.eco|SpeciesLayeredCatch.eco]]
+|Gameplay -> Species Catcher
 |-
-| Skill Gain Multiplier || 1
+|[[Server Configuration/Stats.eco|Stats.eco]]
+|System -> Stats
 |-
-| Specialty Cost Multiplier || 1
+| [[Server Configuration/Storage.eco|Storage.eco]]
+| Initial Setup -> Storage
 |-
-| Specialty Experience Divisor || 20
+| [[Server Configuration/StrangeWorlds.eco|StrangeWorlds.eco]]
+| Initial Setup -> Strange Cloud
 |-
-| Specialty Experience Per Level || 25
+| [[Server Configuration/Twitch.eco|Twitch.eco]]
+| Gameplay -> Twitch
 |-
-| Unlearn Refund Rate || 0.5
+| [[Server Configuration/Users.eco|Users.eco]]
-|}
+| Initial Setup -> Users
-'''High Collaboration (30+ players)'''
-{| class="wikitable"
 |-
-| Player Experience Per Specialty Experience || 0
+| [[Server Configuration/UserTextures.eco|UserTextures.eco]]
+| Gameplay -> User Textures
 |-
-| Skill Gain Multiplier || 1
+| [[Server Configuration/Voice.eco|Voice.eco]]
+| Gameplay -> Voice
 |-
-| Specialty Cost Multiplier || 2
+|[[Server Configuration/Weather.eco|Weather.eco]]
+|Gameplay -> Weather
 |-
-| Specialty Experience Divisor || 20
+| [[Server Configuration/World.eco|World.eco]]
+| Sim -> World
 |-
-| Specialty Experience Per Level || 25
+| [[Server Configuration/WorldGenerator.eco|WorldGenerator.eco]]
+| Sim -> World Generator
 |-
-| Unlearn Refund Rate || 0.5
+| [[Server Configuration/WorldObjects.eco|WorldObjects.eco]]
+| Game Status -> World Objects
 |}
-==== Disasters.eco ====
-==== EcoSim.eco ====
-==== Localization.eco ====
-==== ModKit.eco ====
-==== Network.eco ====
-==== Pause.eco ====
-==== Profanity.eco ====
-==== Rooms.eco ====
-==== Sleep.eco ====
-This file is used to configure the [[Sleep]] feature. It is default disabled for dedicated servers, and enabled for local servers.
-* <code>AllowFastForward</code> (default depends on server type) will allow players to use [[bed]]s to fast-forward time.
-* <code>SleepTimePassMultiplier</code> (defaulted to "500") defines the maximum fast-forward speed.
-* <code>TimeToReachMaximumTimeRate</code> (defaulted "10") defines how long the windup time is to reach that maximum fast-forward speed.
-==== Stats.eco ====
-==== Storage.eco ====
-==== Users.eco ====
-==== World.eco ====
-==== WorldGenerator.eco ====
-==== WorldObjects.eco ====
-==== WorldGenerator.eco ====