Settings, logs and in-game tools

Sunrise reads one settings file at startup, writes one log, and has one in-game menu. The settings code is in src/core/settings/, the log in src/core/logging/, and the menu in src/core/ui/.

The settings file

The file is bin/x64/Sunrise/settings.json. It sits in the Sunrise folder beside the DLL.

• If the file does not exist, Sunrise writes the default file there and uses it. The default is resources/default_settings.json, built into the DLL.
• Sunrise reads it once, at startup. Restart the game after a change.
• The file must be valid JSON and at most 1 MiB. A leading UTF-8 byte order mark is fine.
• Unknown keys are skipped. Most known keys may appear only once; a repeat is an error.
• A key you leave out keeps its built-in default.

If the file does not parse, Sunrise does not start. The reason goes to the debugger output as ev=settings result=fail reason=<step>, because the log is not open yet.

The version key

The root version key is the layout version of the file. This build expects 18.

• A file with a lower version, or with no version key, is deleted and replaced by the default file. Your changes in it are lost. Copy the values you want before you update.
• A file with a higher version is still read. A mismatch line goes to the debugger output.

Layout

{
  "version": 18,
  "core":   { "logging": { ... }, "activity_sdk_generation": { ... } },
  "steam":  { "language": "...", "user": { ... } },
  "client": { "ui": { ... }, "external_server": { ... }, ... },
  "server": { "bap_port": 30974, "gameplay": { ... }, "activation": { ... } },
  "state":  { "activity": { ... } },
  "complete_exotic_catalysts": true
}

Main keys

The default is the value in the default file. Where a missing key takes a different built-in value, the table says so.

Core

Steam

The accepted languages are english, french, german, italian, japanese, brazilian, spanish, russian, polish, schinese, tchinese, latam and koreana.

Client

toggle_key accepts insert, home, end, delete and f1 to f12.

Server

topology takes one of three values:

The gameplay block is checked as a whole. With a topology other than disabled:

• port must be nonzero and even.
• The endpoint binds 16 ports, port, port + 2, up to port + 30. That range must stay below 65536 and must not contain 3074.
• server_reserve_count must be at least 8 and leave at least 4096 of the 8192 slots for the game.
• client_join_grant_count must be at least 400 and at most 8192.

If any check fails, the settings file fails to parse and Sunrise does not start.

State

default_destination must have all eight fields: reason, source_activity_index, activity_index, package_name, bubble_count, stateful_bubble_mask, initial_slice_set and spawn_set_hash. stateful_bubble_mask and spawn_set_hash take a number or quoted hex, like "0xCF".

Root

Values the menu saves

The menu pages do not write settings.json. They save to their own files in the same folder:

The log

Sunrise has two log outputs. Each is switched in core.logging.

The file log is off by default. To get sunrise.log, set file_sink to true. On each start the previous file is renamed to sunrise.log.old, so one earlier run is kept.

If the file sink is on and the file cannot be opened, Sunrise does not start.

The debugger output can be read with any tool that shows OutputDebugString text.

Line format

Every line has the same shape:

<channel> level=<level> t=<ms> ev=<event> key=value key=value ...

• <channel> is one of core, client, state, server, middleware.
• t is milliseconds since the log opened. Gaps in it show stalls.
• ev names the event. Most lines add stage= and result=.
• A line is at most 1024 bytes. Longer text is cut.

Examples from src/server/transport/bap_listener.cpp and src/server/http/server_http.cpp. The t values are made up.

server level=info t=4210 ev=transport stage=listen result=ok port=30974
server level=info t=31877 ev=http method=post route=signon result=ok
server level=info t=32015 ev=transport stage=accept result=ok conn=1

To find problems, search for result=fail, level=error and level=warn.

Log levels

There are four levels, from most to least severe: error, warn, info, debug. The fifth value, off, drops the channel.

Each channel has its own threshold. A line is kept when its level is at or above the threshold. So warn keeps errors and warnings; debug keeps everything.

Every channel defaults to warn. This example turns on the file log, raises server to info and drops middleware:

"core": {
  "logging": {
    "debugger_sink": true,
    "file_sink": true,
    "levels": {
      "core": "warn",
      "client": "warn",
      "state": "warn",
      "server": "info",
      "middleware": "off"
    }
  }
}

To turn logging down:

• Set a channel to error to keep only errors, or to off to drop it.
• Set file_sink to false to stop writing the file.
• Set debugger_sink to false to stop the debugger output.

Debug level is for diagnosis. It adds timing lines, such as the server’s two-second service report.

For the mission script lines and what they mean, see Debugging a script.

The in-game menu

Press Insert to open or close the menu. The key is client.ui.toggle_key. The menu starts closed. With client.ui.enabled set to false, the key does nothing.

The left column lists the pages, in this order: client pages, then server pages, then Core pages.

Changes on the Movement, Player and HUD pages save at once and survive a restart.

Activity Host windows

The World window has one page per kind of authored content: Squads, Idles, Combatants, Devices, Triggers, Objects, Scenes, Dialogue, Directives, Objectives, Cinematics, Engagement, Public event, Occupancy, Lifetime, States, Mission state, Positions, Behaviors and Script.

The Packets window lists the messages the game sent to the Activity Host.

How to use these windows to find content for a script is in Finding things in game.

HUD overlays

Overlays draw in the top-left corner, with the menu open or closed.

The Logs page

The Logs page keeps only the newest 128 lines, in memory. It shows lines that passed the channel thresholds in core.logging.levels, whether or not the file sink is on. A line dropped by the threshold is not on the page either. For a full record, turn on file_sink.