Using the web console - rebaserHEAD/NexusForever GitHub Wiki

This guide gets you running GM commands against a local world server without a client in the loop, by hand or from a script. The message format and the rules the console follows are on Web console.

A page in your browser, or a few lines of PowerShell, that runs any chat command on the server, as any character who's online.

Start the stack (Running it locally), then open http://localhost:5000/console.html. The page connects by itself when it loads.

Type a command in the command box and press Enter. Write it as you would in chat, without the !. Replies land in the log above the box, marked info or error.

Most of the useful commands act on a character: achievements, quests, items, teleports and so on. For those:

1. Log a character in with the client.
2. Put its name in the Character box. A name with a space in it is fine there, and case doesn't matter.
3. Send the command.

If the console answers "Invalid target for this command!", the box is empty or the character isn't online.

For example, with an online character called Test Subject in the box:

achievement grant 1385
quest add 3165
quest achieve 3165
teleport name <zone name>

Account commands need no character. Leave the box empty and run:

account create <email> <password> Administrator

Give every account you'll play on a role, or it can't use commands from chat.

For a long run, send commands over the console's socket instead of typing them. This sends one command as a character and closes:

$none   = [System.Threading.CancellationToken]::None
$socket = [System.Net.WebSockets.ClientWebSocket]::new()
$socket.ConnectAsync([Uri]'ws://localhost:5000/ws/commands', $none).Wait()

$json  = @{ message = 'achievement grant 1385'; character = 'Test Subject' } | ConvertTo-Json -Compress
$bytes = [System.Text.Encoding]::UTF8.GetBytes($json)
$socket.SendAsync([ArraySegment[byte]]::new($bytes), 'Text', $true, $none).Wait()

# the server's read loop only ends on a close frame
$socket.CloseOutputAsync('NormalClosure', 'done', $none).Wait()
$socket.Dispose()

To send several, repeat the send before closing. To read replies, keep a ReceiveAsync running on the same socket before you close it. A command still runs if you close straight away; its reply just has nowhere to go.