-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Settings (playtest)
This documentation displays annotated settings with default values and description. Please do not edit it directly, but add new [Desc("String")]
tags to the source code. This file has been automatically generated for version playtest-20221223 of OpenRA.
All settings can be changed by starting the game via a command-line parameter like Game.Mod=ra
.
- Windows:
%APPDATA%\OpenRA\settings.yaml
- Mac OS X:
~/Library/Application Support/OpenRA/settings.yaml
- Linux
~/.config/openra/settings.yaml
Older releases (before playtest-20190825) used different locations, which newer versions may continue to use in some circumstances:
- Windows:
%USERPROFILE%\Documents\OpenRA\settings.yaml
- Linux
~/.openra/settings.yaml
If you create the folder Support
relative to the OpenRA main directory, everything including settings gets stored there to aid portable installations.
Display average FPS and tick/render times
Default Value: False
Debug:
PerfText: False
Display a graph with various profiling traces
Default Value: False
Debug:
PerfGraph: False
Number of samples to average over when calculating tick and render times.
Default Value: 25
Debug:
Samples: 25
Check whether a newer version is available online.
Default Value: True
Debug:
CheckVersion: True
Allow the collection of anonymous data such as Operating System, .NET runtime, OpenGL version and language settings.
Default Value: True
Debug:
SendSystemInformation: True
Version of sysinfo that the player last opted in or out of.
Default Value: 0
Debug:
SystemInformationVersionPrompt: 0
Sysinfo anonymous user identifier.
Default Value: eb8d43bc-7bb1-47f2-b355-80cf35d5d18a
Debug:
UUID: eb8d43bc-7bb1-47f2-b355-80cf35d5d18a
Enable hidden developer settings in the Advanced settings tab.
Default Value: False
Debug:
DisplayDeveloperSettings: False
Display bot debug messages in the game chat.
Default Value: False
Debug:
BotDebug: False
Display Lua debug messages in the game chat.
Default Value: False
Debug:
LuaDebug: False
Enable the chat field during replays to allow use of console commands.
Default Value: False
Debug:
EnableDebugCommandsInReplays: False
Enable perf.log output for traits, activities and effects.
Default Value: False
Debug:
EnableSimulationPerfLogging: False
Amount of time required for triggering perf.log output.
Default Value: 1
Debug:
LongTickThresholdMs: 1
Throw an exception if the world sync hash changes while evaluating user input.
Default Value: False
Debug:
SyncCheckUnsyncedCode: False
Throw an exception if the world sync hash changes while evaluating BotModules.
Default Value: False
Debug:
SyncCheckBotModuleCode: False
Filename of the authentication profile to use.
Default Value: player.oraid
Game:
AuthProfile: player.oraid
Version of introduction prompt that the player last viewed.
Default Value: 0
Game:
IntroductionPromptVersion: 0
Allow mods to enable the Discord service that can interact with a local Discord client.
Default Value: True
Game:
EnableDiscordService: True
This can be set to Windowed, Fullscreen or PseudoFullscreen.
Default Value: PseudoFullscreen
Graphics:
Mode: PseudoFullscreen
Enable VSync.
Default Value: True
Graphics:
VSync: True
Screen resolution in fullscreen mode.
Default Value: 0,0
Graphics:
FullscreenSize: 0,0
Screen resolution in windowed mode.
Default Value: 1024,768
Graphics:
WindowedSize: 1024,768
Add a frame rate limiter.
Default Value: False
Graphics:
CapFramerate: False
At which frames per second to cap the framerate.
Default Value: 60
Graphics:
MaxFramerate: 60
Set a frame rate limit of 1 render frame per game simulation frame (overrides CapFramerate/MaxFramerate).
Default Value: False
Graphics:
CapFramerateToGameFps: False
Disable the OpenGL debug message callback feature.
Default Value: False
Graphics:
DisableGLDebugMessageCallback: False
Disable operating-system provided cursor rendering.
Default Value: False
Graphics:
DisableHardwareCursors: False
Disable legacy OpenGL 2.1 support.
Default Value: True
Graphics:
DisableLegacyGL: True
Display index to use in a multi-monitor fullscreen setup.
Default Value: 0
Graphics:
VideoDisplay: 0
Preferred OpenGL profile to use.
Modern: OpenGL Core Profile 3.2 or greater.
Embedded: OpenGL ES 3.0 or greater.
Legacy: OpenGL 2.1 with framebuffer_object extension (requires DisableLegacyGL: False)
Automatic: Use the first supported profile.
Default Value: Automatic
Graphics:
GLProfile: Automatic
Sets the player nickname.
Default Value: Commander
Player:
Name: Commander
Sets the server name.
Default Value:
Server:
Name:
Sets the internal port.
Default Value: 1234
Server:
ListenPort: 1234
Reports the game to the master server list.
Default Value: True
Server:
AdvertiseOnline: True
Locks the game with a password.
Default Value:
Server:
Password:
Allow users to search UPnP/NAT-PMP enabled devices for automatic port forwarding.
Default Value: False
Server:
DiscoverNatDevices: False
Time in seconds for UPnP/NAT-PMP mappings to last.
Default Value: 36000
Server:
NatPortMappingLifetime: 36000
Starts the game with a default map. Input as hash that can be obtained by the utility.
Takes a comma separated list of IP addresses that are not allowed to join.
For dedicated servers only, allow anonymous clients to join.
Default Value: False
Server:
RequireAuthentication: False
For dedicated servers only, if non-empty, only allow authenticated players with these profile IDs to join.
For dedicated servers only, if non-empty, always reject players with these user IDs from joining.
For dedicated servers only, controls whether a game can be started with just one human player in the lobby.
Default Value: False
Server:
EnableSingleplayer: False
Query map information from the Resource Center if they are not available locally.
Default Value: True
Server:
QueryMapRepository: True
Enable client-side report generation to help debug desync errors.
Default Value: False
Server:
EnableSyncReports: False
Sets the timestamp format. Defaults to the ISO 8601 standard.
Default Value: yyyy-MM-ddTHH:mm:ss
Server:
TimestampFormat: yyyy-MM-ddTHH:mm:ss
Allow clients to see anonymised IPs for other clients.
Default Value: True
Server:
ShareAnonymizedIPs: True
Allow clients to see the country of other clients.
Default Value: True
Server:
EnableGeoIP: True
For dedicated servers only, save replays for all games played.
Default Value: False
Server:
RecordReplays: False
For dedicated servers only, treat maps that fail the lint checks as invalid.
Default Value: True
Server:
EnableLintChecks: True
Delay in milliseconds before newly joined players can send chat messages.
Default Value: 5000
Server:
FloodLimitJoinCooldown: 5000
Amount of miliseconds player chat messages are tracked for.
Default Value: 5000
Server:
FloodLimitInterval: 5000
Amount of chat messages per FloodLimitInterval a players can send before flood is detected.
Default Value: 5
Server:
FloodLimitMessageCount: 5
Delay in milliseconds before players can send chat messages after flood was detected.
Default Value: 15000
Server:
FloodLimitCooldown: 15000
Players ๐ฒ
- FAQ โ
- Installation ๐ฆ
- Game Content ๐ฟ
- Hotkeys and Stances ๐ฎ
- Strategies ๐
- Settings ๐ง
- Dedicated Server โพ
- RaspberryPi ๐
- Badges & Icons ๐ฅ
- Changelog ๐
Modders โ๏ธ
- Audio guide ๐
- Traits ๐
- Palettes and Remaps ๐จ
- World Coordinate System ๐
- Map scripting
- Lua-API ๐
- Conditions ๐
- Mapping ๐ง
- Pixelart ๐
Developers ๐ง
- Contributing โค๏ธ
- Compiling
- Hacking
- Coding Standard ๐
- Branches and Releases ๐
- Release Checklist โ
- Sequences
- Glossary
- Reverse engineering ๐
- License ยฉ๏ธ