Server Configuration - RimWorld-Together/Rimworld-Together GitHub Wiki

Server Configuration

This guide will help you configure all settings on your server.

In game admin panel:

You can enable the in game admin panel using dev mode and navigating to the menu in the pause menu in game. To make yourself an admin, do:

  1. Enter "deeplist" in the server console.
  2. Find your user, and note down the UID of your user.
  3. Use the "op" command with your UID.
  4. Log in the server and you should be able to enable dev mode.

Configs Folder

ActionConfigs.json

These settings allow you to tweak what features of the mod are turned on or off.

  • Enablectivities: Enables offline visiting and raiding.
  • EnableSites: Enables the creation of sites.
  • EnableRoads: Enables the creation of user built roads.
  • EnableFactions: Enables the creation of user made factions.
  • EnableAids: Enables the transfer of pawns.
  • EnableTrading: Enables the transfer of items.
  • EnableSpying: Enables spying on offline.
  • EnableCustomScenarios: Allows users to select custom scenarios.
  • EnableNPCDestruction: Allows users to permanently destroy NPC settlements.
  • EnablePollutionSpread: Allows users with Biotech to spread pollution to world tiles, including other players.
  • EnforcedGameSpeed: Set the game speed the server will be running at. 0 means no restriction.
  • SpyCost: Cost of spying on a player.

BackupConfig.json

These settings allow you to automatically backup your server.

  • AutomaticBackups: Enables this system.
  • IntervalHours: Amount of hours in between backups. Keep in mind a backup is generated at every launch of the server.
  • AutomaticDeletion: Removes old backups.
  • Amount: Maximum amount of backups before automation deletion.

ChatConfig.json

These settings are for managing the in game chat.

  • EnableMoTD: Sends a welcome message to all players that log in.
  • MessageOfTheDay: Message send.
  • LoginNotifications: Sends a message when an user logs in.
  • DisconnectNotifications: Sends a message when an user logs off.

DifficultyConfig.json

These settings are for managing the difficulty of the storyteller. These are the same as the ones found in "custom" under the vanilla in game menu. You can configure them through the in game admin panel and at server creation.

ModConfig.json

These settings are for managing the modlist of your server. These can be set during server creation, and through the in game admin panel.

RoadConfig.json

These settings are for managing user built roads. The cost are in silver.

ScenarioConfig.json

These settings are for enforcing a specific scenario. Configurable at server creation.

ServerConfig.json

These settings are for managing the internal working of the server.

  • Name: The name of your server. Max of 40 characters.
  • Description: The description of your server. Max of 200 characters.
  • IP: The local network inferface your want to bind to. Leaving it to 0.0.0.0 is recommended.
  • Port: The local port you want to bind to. Remember to port forward!
  • MaxPlayers: The maximum amount of players that can connect at once.
  • EnableServerBrowser: Allows your server to be visible on the server browser.
  • PublicEndPoint: Your public facing ip address / DNS / Domain. (Used by the server browser).
  • VerboseLogs: More descriptive error messages.
  • ExtremeVerboseLogs: Logs a lot of information. Useful for bug reporting.
  • UseUpnp: Enables your server to use UpnP if your router supports it.
  • SyncLocalSave: If true, the server will not check if the save was modified between logins.
  • TemporalActivityProtection: Cooldown between receiving Activity request.
  • TemporalEventProtection: Cooldown between receiving player-sent events.
  • TemporalAidProtection: Cooldown between receiving player-sent aid.
  • TemporalSpyProtection: Cooldown between spying attemps.

SiteConfig.json

These settings are for managing how your sites behave:

  • DefName: Internal code name for your sites. Do not touch unless you know what you are doing.
  • DefNameCost: Internal name of the item you want to add to the cost of the site. Can support multiple inputs
  • Cost: Amount of items needed. Can support multiple inputs.
  • Rewards: The possible rewards of your site. Each reward is composed of:
    • RewardDef: Internal name of the item you want as a reward.
    • RewardAmount: Amount of items rewarded.

StorytellerConfig.json

These settings are for enforcing a storyteller. Configurable at server creation.

WhitelistConfig.json

You can whitelist user UIDS here. To whitelist an user, allow them to create an account, and then write their UID down.

Assets/Events

You can store event that players can call on other players here.

  • Name: The name of the event.
  • DefName: The internal name of the event.
  • Cost: The cost in silver.
  • IsEnabled: Enables the event.