Skip to main content
Reference

Settings Reference

Project Settings → Plugins → Server Admin Core, stored in Config/DefaultGame.ini under [/Script/ServerAdminCore.ServerAdminCoreSettings]. The Config key column is the name to use in the ini file.

General​

SettingConfig keyDefaultDescription
EnabledbEnabledtrueTurns ServerAdminCore on or off.
Active On Listen ServerbActiveOnListenServertrueRun ServerAdminCore on listen servers, where the hosting player's game is the server. Dedicated servers are always active.
Active In StandalonebActiveInStandalonefalseAlso run ServerAdminCore in standalone games.
Listen Server Host Is OwnerbListenServerHostIsOwnertrueOn a listen server the hosting player is treated as an owner.
Data DirectoryDataDirectory–Folder for data files. Empty = <Project>/Saved/ServerAdminCore. Relative paths are relative to the project folder. Can be overridden with -ServerAdminCoreDataDir=<path>.
Storage ClassStorageClassServerAdminCoreJsonStorageStorage backend. Subclass UServerAdminCoreStorage to use a database or web API instead of JSON files.
Auto Add Player ComponentbAutoAddPlayerComponenttrueComponent added to every player controller on the server. Used for chat, commands, announcements and admin panels.
Player Component ClassPlayerComponentClassServerAdminCorePlayerComponentClass of the auto-added player component. Use your own subclass to extend it.
Enable Console InputbEnableConsoleInputtrueRead commands typed into the dedicated server console (the Windows -log window, or the terminal on Linux). Lines run as ServerAdminCore commands or Unreal console commands. Disable with -NoServerAdminCoreConsole.

Permissions​

SettingConfig keyDefaultDescription
Owner IdsOwnerIds–Player ids that always have every permission. Can be extended with -ServerAdminCoreOwners=Id1,Id2
Owner Group NameOwnerGroupName"Owner"Group name reported for owners.
Default Group NameDefaultGroupName"Default"Group used for players without an assigned group.
Default GroupsDefaultGroupsOwner, Admin, Moderator, DefaultGroups created the first time the server runs (when no Groups.json exists). Edit groups at runtime with commands or Blueprint afterwards.
Enforce ImmunitybEnforceImmunitytruePlayers can only act on players with a lower group priority.

Moderation​

SettingConfig keyDefaultDescription
Whitelist Enabled By DefaultbWhitelistEnabledByDefaultfalseWhitelist state the first time the server runs.
Record IP AddressesbRecordIPAddressestrueStore the last IP address of each player.
Enforce IP BansbEnforceIPBanstrueReject players whose IP address matches an IP ban.
Mute Voice ChatbMuteVoiceChattrueAlso mute voice chat (APlayerController::GameplayMutePlayer) for muted players.
Ban MessageBanMessage"You are banned from this server. Reason: {Reason}"Formats support {Reason}, {Expires}, {Duration}, {By}.
Temp Ban MessageTempBanMessage"You are banned from this server for {Duration}. Reason: {Reason}"Shown to temp banned players. Supports {Reason}, {Duration}, {Expires}, {By}.
Kick MessageKickMessage"You were kicked from the server. Reason: {Reason}"Shown to kicked players. Supports {Reason}, {By}.
Mute MessageMuteMessage"You are muted. Reason: {Reason}"Sent to permanently muted players.
Temp Mute MessageTempMuteMessage"You are muted for {Duration}. Reason: {Reason}"Sent to temp muted players.
Whitelist MessageWhitelistMessage"This server is whitelisted."Shown to players who are not whitelisted.
Default ReasonDefaultReason"No reason given"Used when no reason is given.

Chat and Commands​

SettingConfig keyDefaultDescription
Command PrefixCommandPrefix"/"Chat messages starting with this prefix are run as commands.
Broadcast Chat To PlayersbBroadcastChatToPlayerstrueSend chat from UServerAdminCorePlayerComponent::SendChatMessage to every player. Disable if you only want OnChatMessage and handle delivery yourself.
Max Chat Message LengthMaxChatMessageLength256Longer chat messages are cut.
Log Chat To OutputbLogChatToOutputtrueWrite chat to the output log.
Log All CommandsbLogAllCommandsfalseWrites every executed command to the admin log, in addition to the action itself.

Announcements​

SettingConfig keyDefaultDescription
Scheduled AnnouncementsScheduledAnnouncements–Messages repeated on an interval. See Server Announcements.
Welcome MessageWelcomeMessage–Shown to a player when they join. Empty = disabled. Supports {Player}.

Auto Kick​

See AFK and High Ping Kick.

SettingConfig keyDefaultDescription
Afk Kick EnabledbAfkKickEnabledfalseKick players that have been idle for Afk Kick Seconds. Players with serveradmincore.afk.bypass are never kicked.
Afk Kick SecondsAfkKickSeconds600Seconds without activity before a player is kicked. Moving or turning the pawn, chat and commands count as activity. Minimum 30.
Afk Warning SecondsAfkWarningSeconds60Seconds before the kick at which the player is warned. 0 = no warning.
Afk Min PlayersAfkMinPlayers0Only kick idle players when at least this many players are online. 0 = always.
High Ping Kick EnabledbHighPingKickEnabledfalseKick players whose ping stays above Max Ping Ms for High Ping Grace Seconds. Players with serveradmincore.ping.bypass are never kicked.
Max Ping MsMaxPingMs250Ping limit in milliseconds.
High Ping Grace SecondsHighPingGraceSeconds30Seconds in a row the ping has to stay above the limit before the player is kicked.
Ping Check Delay After JoinPingCheckDelayAfterJoin30Ping is not checked during the first seconds after joining or a map change.
Afk Warning MessageAfkWarningMessage"You will be kicked for being AFK in {Time}."Supports {Time}. Empty = no message, On Auto Kick Warning still fires.
Afk Kick MessageAfkKickMessage"You were kicked for being AFK for {Time}."Supports {Time}.
High Ping Warning MessageHighPingWarningMessage"Your ping ({Ping} ms) is above the server limit of {MaxPing} ms. You will be kicked in {Time} if it stays this high."Supports {Ping}, {MaxPing}, {Time}. Empty = no message, On Auto Kick Warning still fires.
High Ping Kick MessageHighPingKickMessage"You were kicked because your ping ({Ping} ms) was above the server limit of {MaxPing} ms."Supports {Ping}, {MaxPing}.

Server Control​

SettingConfig keyDefaultDescription
Restart ModeRestartModeEServerAdminCoreRestartMode::RelaunchProcessRelaunch Process, Exit Process or Reload Map. See Change Map, Restart and Shutdown.
Restart Exit CodeRestartExitCode0Exit code used for restarts in Exit Process and Relaunch Process mode.
Countdown WarningsCountdownWarnings600, 300, 120, 60, 30, 15, 10, 5, 4, 3, 2, 1Seconds left at which a countdown warning is announced.
Map AliasesMapAliases–Short names for maps, e.g. "arena" -> "/Game/Maps/Arena".
Map Search PathsMapSearchPaths/GameContent paths searched when a map is given by short name and listed by the "maps" command.
Restart Warning MessageRestartWarningMessage"Server restarting in {Time}. {Reason}"Supports {Time}, {Reason}, {Map}.
Shutdown Warning MessageShutdownWarningMessage"Server shutting down in {Time}. {Reason}"Countdown warning for shutdowns.
Map Change Warning MessageMapChangeWarningMessage"Changing map to {Map} in {Time}."Countdown warning for map changes. Supports {Time}, {Map}.
Cancelled MessageCancelledMessage"The scheduled server action was cancelled."Announced when a scheduled action is cancelled.
Shutdown Kick MessageShutdownKickMessage"The server is shutting down. {Reason}"Kick message when the server shuts down. Supports {Reason}.
Restart Kick MessageRestartKickMessage"The server is restarting. {Reason}"Kick message when the server restarts. Supports {Reason}.

Logging​

SettingConfig keyDefaultDescription
Write Log FilesbWriteLogFilestrueWrites admin logs to <DataDirectory>/Logs/AdminLog-YYYY-MM-DD.jsonl
Max Log Entries In MemoryMaxLogEntriesInMemory2000Admin log entries kept in memory.
Log Joins And LeavesbLogJoinsAndLeavestrueLog player joins and leaves.