Run commands over RCON

Manage accounts, edit characters, award XP and send announcements over RCON. You need access to the server configuration and an RCON client.

There is no in-game screen for this. RCON is the server's remote console.

Connect to the server

  1. Set a private RCON password in storyforce_server.cfg:

    set rconpassword "<your own password>"
    
  2. Apply the setting at the server console or restart the server.

  3. Connect your RCON client using the server address, UDP port and password. The default port is 29070.

RCON sends passwords and commands without encryption. Use a private network or tunnel between the client and server.

Test an announcement

Send this through RCON. It displays a 5-second message to everyone.

The example shows the structured reply. Log lines may also arrive.

Seconds are limited to 1 to 30. Send sf_centersay [<player|all>] clear to remove the message early.

Manage accounts and characters

CommandUse
sf_givexp <target> <amount> <reason>Award or remove XP
sf_comadmin create <account> [password]Create an account
sf_comadmin resetpw <account>Generate a new password
sf_comadmin initiate|retire|reinstate|disable <account>Change membership or disable access
sf_comadmin admin promote|demote <account>Change admin rank by one step
sf_comadmin status|faction|rank <character|player> <0-8>Set a designation
sf_comadmin mentor <character|player> <mentorcharacter|none>Set or remove a mentor
sf_managecharacter …Manage full character records

For XP, use char:<id> to target an exact character, including one who is offline. A positive amount awards XP. A negative amount removes it.

The per-award limit still applies. Mentored characters may receive a pending claim. Check the reply's result before telling someone the XP was awarded.

Identify the person making a request

Add these options at the end:

OptionEffect
as=<account>Apply that game account's permissions
by=<text>Record who requested the action in the log
id=<token>Match the reply to a request, using 1 to 32 letters, numbers, underscores or hyphens

Without as=, commands use full console authority. Keep the RCON password with trusted server admins.

sf_managecharacter always uses full console authority and refuses as=. by= grants no permission.

Handle passwords

create without a password and resetpw return a generated password in the account record. Give it privately to the account owner.

A supplied password must contain 4 to 16 letters and numbers. It is not returned in the reply. Have the player change it in game.

Both account creation forms and password resets require RCON. They are refused at the local server console. Use root reset for the root account.

Read a complete reply

Replies contain an OK or ERR header, rec= records and an END line. Fields are separated by tabs.

Wait for the header, END and the number of records stated by n. Packets may arrive out of order. Ignore unrelated log lines.

An incomplete reply means the outcome is unknown. Check the resulting state before repeating a change. Reusing id= does not prevent a duplicate action.

Send one request at a time, about one per second under the default rate limit. Excess requests can be dropped without a reply.

Next