Skip to content

gemwright.json

gemwright init writes gemwright.json; gemwright shard commands read it from the current directory. It is validated before any change, and an invalid file fails with the field to fix. Add "$schema" to get completion and these descriptions in your editor.

Shard

FieldTypeDescription
$schemastring Path or URL of this JSON Schema, for editor completion.
schemaVersion1 Configuration format version. Missing means 1.
name *string Shard name players see, 1-32 printable ASCII characters.
id *string The name as a lowercase, hyphenated slug; must match name. Names services, folders and deployments.
adminEmailstring Support email written into the emulator configuration.
urlstring Support website written into the emulator configuration. Sphere requires it without http(s)://.
timezone *string IANA timezone the shard runs in, e.g. Europe/London.
expansion *"base" "t2a" "uor" "td" "lbr" "aos" "se" "ml" "sa" "hs" "tol" "ej" Expansion era the shard plays as, from base (pre-T2A) to ej (Endless Journey).
emulator *"servuo" "sphere" "sphere-x" "runuo" "modernuo" Server emulator the shard runs.
target"local" "railway" "vps" Default deployment target; saved by the last successful deploy.

client

FieldTypeDescription
client *object The classic client players connect with.
client.version *string Client version, four numbers such as 7.0.45.1. AI residents speak it too.

source

FieldTypeDescription
sourceobject Emulator source pinned to an exact revision.
source.repository *string Git repository.
source.ref *string Branch or tag the revision was resolved from.
source.revision *string Full 40-character commit hash.

runuo

FieldTypeDescription
runuoobject RunUO settings.
runuo.clientFilesstring Folder with the UO client files; the default for --files.
runuo.owner *string Owner (administrator) account name, 1-16 letters, digits, _ or -.
runuo.autoCreateAccounts *boolean Whether logging in with a new account name creates the account.

modernuo

FieldTypeDescription
modernuoobject ModernUO settings.
modernuo.clientFilesstring Folder with the UO client files; the default for --files.
modernuo.owner *string Owner (administrator) account name, 1-16 letters, digits, _ or -.
modernuo.autoCreateAccounts *boolean Whether logging in with a new account name creates the account.

servuo

FieldTypeDescription
servuoobject ServUO settings.
servuo.clientFilesstring Folder with the UO client files; the default for --files.
servuo.owner *string Owner (administrator) account name, 1-16 letters, digits, _ or -.
servuo.autoCreateAccounts *boolean Whether logging in with a new account name creates the account.
servuo.accountsPerIpinteger Accounts allowed per IP address; 0 for unlimited.
servuo.globalChatboolean Whether the global chat system is enabled.
servuo.allowedClientslist of string Client kinds allowed to connect: AllowRegular, AllowUOTD, AllowGod and/or AllowEC (Config/Client.cfg).

sphere

FieldTypeDescription
sphereobject Sphere and Sphere-X settings.
sphere.scriptsSource *object Sphere scripts source pinned to an exact revision.
sphere.scriptsSource.repository *string Git repository.
sphere.scriptsSource.ref *string Branch or tag the revision was resolved from.
sphere.scriptsSource.revision *string Full 40-character commit hash.
sphere.mysqlboolean Whether Sphere scripts use a MySQL database, added during deployment.
sphere.clientFilesstring Folder with the UO client files; the default for --files.
sphere.autoCreateAccounts *boolean Whether logging in with a new account name creates the account.
sphere.owner *string Owner (administrator) account name, 1-16 letters, digits, _ or -.
sphere.maps *"expansion" "felucca" expansion: every map the expansion includes; felucca: Felucca only.
sphere.mapSize *"modern" "legacy" modern or legacy Felucca/Trammel map size; legacy cannot be used from ML onwards.
sphere.clientEncryption"encrypted" "both" "unencrypted" Which clients are accepted: encrypted, unencrypted or both.
sphere.rulesobject Classic Sphere combat and rule values written to sphere.ini. Not supported on Sphere-X.
sphere.rules.combatFlags *number sphere.ini CombatFlags.
sphere.rules.archeryMovementDelay *number sphere.ini CombatArcheryMovementDelay.
sphere.rules.damageEra *number sphere.ini CombatDamageEra.
sphere.rules.hitChanceEra *number sphere.ini CombatHitChanceEra.
sphere.rules.speedEra *number sphere.ini CombatSpeedEra.
sphere.rules.speedScaleFactor *number sphere.ini SpeedScaleFactor.
sphere.rules.magicFlags *number sphere.ini MagicFlags.
sphere.rules.racialFlags *number sphere.ini RacialFlags.
sphere.rules.revealFlags *number sphere.ini RevealFlags.
sphere.rules.npcAI *number sphere.ini NPCAI.

ai

FieldTypeDescription
aiobject AI residents (ServUO only): how many, how they decide and speak, and where they live.
ai.populationinteger Number of AI residents.
ai.decisionssee description Who decides what residents do: local, jev, clef, or an ordered provider list ending in local. Earlier providers fall back to later ones.
ai.speech"authored" "claude" authored: written lines; claude: replies in each resident's own voice by Claude (requires ANTHROPIC_API_KEY).
ai.raceslist of "human" "elf" "gargoyle" Races new residents are created as; human and elf by default.
ai.chaosnumber How unpredictable residents are, 0 (always the direct way) to 1; 0.3 by default.
ai.warsboolean Whether the Order and Chaos guild alliances go to war with each other. Off by default.
ai.citieslist of "Britain" "Buccaneer's Den" "Cove" "Jhelom" "Magincia" "Minoc" "Moonglow" "New Haven" "Nujel'm" "Serpent's Hold" "Skara Brae" "Trinsic" "Vesper" "Wind" "Yew" The only cities AI residents go to (shops, banks, healers, moongates and the grounds around them); every city when unset.
ai.debugboolean Whether residents emote their current phase above their heads. Off by default.

packages

FieldTypeDescription
packagesobject Exact published component versions selected by gemwright shard update. Unset components use the versions carried by the CLI.
packages.serverstring Exact @gemwright/server version.
packages.clientstring Exact @gemwright/client version.
packages.aistring Exact @gemwright/ai version.

railway

FieldTypeDescription
railwayobject Railway project the shard deploys to.
railway.project *string Railway project.
railway.environment *string Railway environment.
railway.serverstring Existing Railway server service the client and AI connect to.

vps

FieldTypeDescription
vpsobject VPS deployment settings.
vps.sshstring SSH destination: an alias or user@hostname.
vps.portinteger SSH port; the SSH configuration's when unset.
vps.pathstring Dedicated deployment directory on the VPS; gemwright/<id> by default.
vps.publicHost *string Address native clients connect to.
vps.domainstring HTTPS hostname of the browser client.

connection

FieldTypeDescription
connectionobject An existing server the client and AI connect to instead of a server deployed by Gemwright.
connection.host *string Server host.
connection.port *integer Server port, 2593 by default.
connection.aiReadyboolean Confirms the external server has the ServUO AI patch, account creation and a trusted AI source.

* required when its parent is present.