Server Configuration: Difference between revisions

From Eco - English Wiki
[unchecked revision][checked revision]
Updating with latest config information; filling out missing config files.
Added more details
 
Line 2: Line 2:
__NOTOC__
__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.
[[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.
== 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 ==
== 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. Also see [[Server Configuration/WorldGenerator.eco|WorldGenerator.eco]] for configuration related to world generation and [[Server Configuration/EcoSim.eco|EcoSim.eco]] for configuration related to the climate.
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 (advanced) ==
Editing config files can allow for more detailed changes. You can alter world generation and gameplay in many ways.
Editing config files can allow for more detailed changes. You can alter world generation and gameplay in many ways.
Line 12: Line 26:
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.
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.


Any changes made to these configuration files will require a server restart before they will take effect.
=== 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/ 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 ===
=== List of Configuration Files ===
{| class="wikitable sortable content-size"
{| class="wikitable sortable content-size"

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

[edit | edit source]
  • 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

[edit | edit source]

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

[edit | edit source]

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

Basic Configuration

[edit | edit source]

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)

[edit | edit source]

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

[edit | edit source]

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

[edit | edit source]
  1. Edits to WorldGenerator.eco require a server wipe to take effect.
  2. Whitelisting allows whitelisted players to ignore the requirement for a password but for whitelisting to work you must set a password.
  3. When changing the map size keep the map values divisible by 4 or risk severe issues.
  4. 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
  5. Any changes made to these configuration files will require a server restart before they will take effect.

List of Configuration Files

[edit | edit source]
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