Skip to content

Using the RC tool

Borne RC is the desktop tool that staff use to look after a server. It connects to the /rc endpoint of the server. Staff sign in with their game account and do not enter the game world. An account can have a game session and an RC session at the same time.

An RC login is accepted only when all of these hold:

  1. The password is right and the account is not banned or disabled.
  2. The account is staff, which means it has a staff entry (staff bootstrap).
  3. The connection matches one of the login patterns of the account. An empty list allows no RC login.

A login pattern is one of:

  • an IPv4 pattern with four parts, each a number or *, for example 45.234.*.*;
  • an IPv6 address, written exactly, or as a prefix address/length;
  • pc:<id>, which matches the PC ID of the computer.

The list first-login, written alone, is replaced by the address of the first successful RC login (staff bootstrap).

Separate patterns with commas: 45.234.*.*,pc:131253742. A modified client can fake a PC ID. It helps against ordinary players, not against a determined one, so do not use it as the only protection.

After a successful login the tool can save the account in an encrypted vault in its configuration folder. The password never goes back to the interface.

The server checks every action against the rights and folder rights of the account when the action happens. Hiding a button in the tool is never the check.

Closing the main window hides the tool in the system tray and keeps the connection running. Click the tray icon, or choose Open in its menu, to show the window again; Close in the menu quits. Script editor windows close normally. On a Linux desktop without a tray, closing the window quits as before.

Staff rights lists the 19 rights. Folder rights say which folders an account may read and write. They are one rule per line, a mode and a pattern:

rw WEAPONS/*
rw WEAPONS/*/*
rw NPCS/*
rw CLASSES/*
rw databases/*
rw levels/*
r images/*
  • The mode is r, w, or rw.
  • * matches any name inside one folder level. Each deeper level needs its own line.
  • WEAPONS, NPCS, and CLASSES are virtual folders for the script editors. A weapon name can hold /, which makes depth, so WEAPONS/*/* is a second line.
  • Access is denied unless a rule allows it. Rules cannot deny, and overlapping rules add up (OQ-RC-1).

Editing scripts needs both the NPC-Control right and a folder rule: r to read and w to save.

The tool has editors for database NPCs, weapons, and classes. They use the Monaco editor with live diagnostics from the same compiler as the server, completion, and hover help from the API reference.

When you save a script, the server:

  1. checks your rights and that nobody saved a newer version in between. On a conflict you get a merge view;
  2. compiles both halves. On any compile error it refuses the save, keeps the active version, and shows the errors in the editor and in the RC chat;
  3. stores the new version with a history entry and writes the audit log;
  4. reloads it:
    • a database NPC attaches the new code and runs onCreated again;
    • a weapon reloads on the server and runs onCreated, and the new client half goes to every connected owner;
    • a class does not change objects that already joined it. Each of them gets onJoinedClassUpdated(className), and a new join uses the new version.

Every create, update, rename, and delete is announced to all RC sessions as a line in the chat. The history window lists earlier versions, compares them, and restores one (a restore is a new save).

Level NPC scripts are part of the level files. Upload the level with the file browser.

Browse the folders your folder rights allow. You can download, upload, delete, rename, and make folders. Uploads are limited to 32 MiB a file. Uploading a level that is loaded updates it, without removing the NPCs that scripts made with putnpc2 or changing their state.

Double-click a file (or choose Open) to open a local copy with your computer’s default program for that kind of file. When you save the copy, the tool uploads it back, the same way local copies of scripts work. Open as text opens any file in the tool’s text editor and saves it back as UTF-8. Both use your folder rights and the 32 MiB limit.

The folder configuration (right: Edit folder configuration) says which folders game clients may download, one rule per line:

level levels/*.nw
level levels/*/*.nw
file images/*
file tiles/*
head heads/*.png
body bodies/*.png
sword swords/*.png
shield shields/*.png
gani ganis/*.gani
sound sounds/*

These are the default rules of a new server.

The types are level, file, head, body, sword, shield, gani, and sound. A folder that is not listed, such as databases or logs, is never downloadable by players. The order of the lines decides which file wins when two folders hold the same name.

The levels view lists each loaded level with its player count, its idle time, and what keeps it loaded: the name of the object and the reason (a timer, a scheduled event, a waiting function, or keepalive). A level with no players unloads after levelunloadtime seconds only when nothing keeps it active. A timer loop in a level NPC keeps the level loaded for ever.

When a level file (.nw) or a gmap (.gmap) changes on the server disk, for example because you edited it as text, the players in it see the change within a few seconds without warping. A changed gmap is read again and its players enter it with the new layout. /update level <name> in the RC chat forces the same reload when the file did not change.

The Server Options editor changes the key=value text, and changes apply at once. Server flags (server. and serverr.) have an editor with search by name prefix. See configuration.

  • The player list shows who is online with account, nickname, level, and position. With the right to view attributes it also shows the IP address. From it you can inspect, edit, reset, warp, kick, ban, or send an admin message, each needing its own right.
  • Bans match by account, IP pattern, or PC ID. A ban can have a reason and an expiry. Banning an online account disconnects it.
  • Staff accounts, comments on accounts, and creating player accounts are in the staff section.

Offline accounts can be inspected and edited from the database.

The reports view lists content the engine found while loading:

  • levels that contain baddies from old level files (the engine does not draw them);
  • files and objects with GS1 code;
  • scripts that use old character property codes;
  • links flagged for a possible parameter order problem;
  • binary levels with skipped corrupted sections;
  • scripts that call built-ins that are not implemented yet.

A server script can add its own tabs to the RC chat, next to “RC Chat”, for logs of its own and for commands only that script understands. The tab strip shows them after “RC Chat”. A tab is read-only unless the script makes it writable, and its input is disabled while it is read-only. The server keeps the last 20 lines of each tab, so a tab opened later still shows them, and every line is also written to the RC log as [tab name] text. Typing in a tab needs no right beyond being logged in. See RCTab, addtab, echo2, findrc, onRemoteControlLogin, and onRCTabMessage in the API reference.

The Performance tab of the Administration window shows how the server is doing: CPU, memory, tick time, players, NPCs, loaded levels, and a table of the costliest script functions of the last minute (calls, total time, longest run). It needs the right to change Server Options, because the table names scripts and the numbers describe the whole machine. The server keeps ten minutes of history in memory, which a restart clears. The tab asks every two seconds while it is open and writes nothing to the audit log.

The chat is the channel for staff with RC open. It shows echo output, script errors and limit reports, compile errors, login and logout notices, and protocol alerts. Text without a leading / goes to all staff.

Command What it does
/scripthelp <topic> Prints the members of a type, or the signature of a built-in
/find <account> Shows where a player is (needs the right to view attributes)
/nick [name] Shows or sets your own nickname
/update level <level.nw|map.gmap> Reloads a level (or every loaded level of a gmap) for the players inside, even when the file did not change; /updatelevel <name> also works (needs Update level)
any other /command Raised as onRCChat(cmd, params) on database NPCs that define it

Every action that changes state is written to the audit log with via = 'rc'.

Engine version 0.1.0. Built 2026-11-18.