BAUD GAMES / ORIGINAL ANSI DOOR
300 Baud
Sysop Guide
Choose either a remote-door connection or a native installation on your own BBS. Neither option requires Python on your BBS.
Use the remote door and let its operator maintain the game, or install the native door locally and manage your own saves and updates. For a local installation, follow the global leaderboard setup below to connect your BBS to the shared rankings.
Use the remote door from your BBS
A remote door lets callers select a game on their own BBS while the game runs on a shared host. The host updates the game; connecting sysops keep their menu entry. You configure a connection in your BBS menu; the hosting operator maintains the game, saves, and updates. No game executable or Python installation is needed on your BBS for this option.
For a game installed directly under your own BBS, use INSTALL.md. For gameplay, open MANUAL.html in a browser.
Get your connection details
Ask the hosting operator for the endpoint, port, BBS ID, and secret for your BBS and the selected game. The examples below use a local tunnel endpoint, not a public service address. No public shared host is bundled with the game.
RLogin is plaintext. Use a private VPN or SSH tunnel between the BBS and host. The secret belongs to the BBS, not an individual player; do not use a caller's normal BBS password. Each sysop vouches for their own callers.
Synchronet
Save this as exec/300baud.js, replacing the endpoint and credential:
bbs.rlogin_gate("127.0.0.1:1513", "siteid:SECRET", user.alias, "ansi/57600", 0);
Create an online program whose command is ?300baud. For Roll and Hack, use a
separate script/menu entry and the endpoint and credential issued for that game
(use the port assigned by the operator).
Mystic
Create a menu entry with command IR and data:
/addr=127.0.0.1 /port=1513 /user=@USER@ /pass=siteid:SECRET /term=ansi/57600
Substitute the assigned endpoint, port, and credential. Mystic replaces
@USER@ with the caller's name. Use a separate entry for Roll and Hack.
Identity and connection check
The gateway expects these NUL-terminated RLogin fields after the initial NUL:
- Client-user:
siteid:SECRET. - Server-user: the caller's handle.
- Terminal:
ansi/57600.
If a client reverses the identity fields, configure it to send the credential
first. Handles must be 1–40 ASCII letters, digits, spaces, ., _, or -,
start with a letter or digit, and not end in a space. The saved identity is
lowercase siteid:handle. Changing either part creates a different account.
Simultaneous sessions for one account are rejected. Other BBSes have separate
accounts even when callers share a handle.
Test the actual BBS menu entry: confirm ANSI/CP437 art, input, clean return, reconnect to the same account, carrier loss, and two distinct callers at once. The configuration examples follow the client documentation but still need validation on your particular BBS/version: Synchronet gateway, Mystic IR command.
Global leaderboard
The hosting operator configures the global leaderboard for the hosted game.
Connecting sysops do not install or schedule leaderboard-upload, and the BBS
connection secret is not a leaderboard credential. Ask the operator whether
leaderboard submissions are enabled and report missing Global scores to them.
If you install 300 Baud on your own BBS instead, follow INSTALL.md and set up your own uploader using LEADERBOARD_UPLOAD.md.
Troubleshooting your connection
| Symptom | Check |
|---|---|
| Connection refused | Assigned endpoint/port and private tunnel or VPN; ask the operator whether the service is running |
| Connection rejected | Assigned BBS ID and secret, field order, allowed handle, or an existing session for that caller |
| Wrong/new profile | Use the same BBS ID and caller handle; contact the operator before changing either |
| Garbled art | Caller terminal supports ANSI and CP437, with at least 80 columns |
| Timeout or server busy | Retry later; ask the operator about session limits if it persists |
Give the operator your BBS software/version, caller handle, approximate failure time, and the displayed error. Do not include the BBS secret in public reports.
Install 300 Baud on your own BBS
Run the native door executable locally under your existing BBS. Download the package for your operating system; neither Python nor a Pascal compiler is needed. Keep this guide beside the executables; all commands below run from that installation directory. The game expects an 80-column, 24-row ANSI terminal with CP437 characters.
If you prefer to use the remote door, configure a BBS menu connection using REMOTE_DOOR.md. The operator then maintains the game for you. Players can open MANUAL.html offline or print it.
1. Install and check locally
Choose the package matching the operating system and architecture of the door
process: windows-x86, windows-x64, or linux-x64. The Windows packages are
native executables, not DOS doors. Check VERSION and BUILD-INFO.txt for the
release, platform, and source revision. An archive with target=unspecified
is a developer build, not a verified Windows/Linux distribution.
Extract the entire package into a permanent game directory, for example
C:\BBS\Doors\300baud or /opt/300-baud. Keep ansi/ and text/ alongside
the executables. Run the game under the BBS service account, with permission
to read the assets and create/update the configuration, data/, and logs/.
Use one installation directory for this BBS's shared player records.
Windows
In Command Prompt:
cd /d C:\BBS\Doors\300baud
install-or-upgrade.bat
baud300.exe -L
Linux
After extracting the .tar.gz package:
cd /opt/300-baud
chmod +x baud300 config-upgrade leaderboard-upload util300
./config-upgrade
./baud300 -L
The configuration tool creates baud300.ini from baud300.ini.defaults.
Edit the live baud300.ini to set your policy. Running the tool again preserves
existing values; --dry-run previews missing keys without writing changes.
In local mode, enter a test handle, open Help, start a run, and check that the map, dice, and box-drawing characters display correctly. Quit to the menu and choose Quit to BBS. This checks the executable and assets; it does not test remote socket handoff. Local testing in your live directory creates player data. Use a separate extracted copy if you want to keep test records out of your BBS.
2. Add the door to your BBS
Configure the BBS door entry to launch the matching native executable, set its
working directory to the game directory, and generate a fresh dropfile for the
current caller/node. Prefer DOOR32.SYS when your BBS supports native socket
doors. The runtime also recognizes DOOR.SYS, DORINFO*.DEF, and INFO.*;
recognizing a dropfile does not establish that its transport works with every
BBS/platform combination.
Windows launch example (node 1 shown):
cd /d C:\BBS\Doors\300baud
baud300.exe -DC:\BBS\Node1\DOOR32.SYS
Linux launch example:
cd /opt/300-baud || exit 1
exec ./baud300 -D/opt/bbs/node1/door32.sys
Replace the example paths with your actual installation and the current node's
dropfile. In a multi-node BBS, use your BBS's node-path substitution or a launcher
argument; never hard-code node 1 for every caller. Linux paths are case-sensitive.
For paths containing spaces, quote the entire argument, for example
"-DC:\My BBS\Node1\DOOR32.SYS". There is no space between -D and its path.
The BBS must pass/inherit the live connection handle described by the dropfile;
a copied or old dropfile is not a remote connection.
Other runtime options:
| Option | Purpose |
|---|---|
-L |
Local interactive login; omit for remote callers |
-N1 -S1000 |
Direct node/socket handoff; values must come from the BBS, not these example numbers |
-X |
Standard-input/output transport; use only with a BBS launcher configured for STDIO, together with caller information such as a dropfile |
/? |
Print command-line help (./baud300 '/?' in a Unix shell) |
BBS products use different door-menu fields and substitution tokens. These are executable-level examples, not certified Mystic or Synchronet configurations. Use your BBS's native-door/socket or STDIO instructions for the transport.
Before opening the menu entry to callers, connect through the BBS as a test user. Verify the correct caller identity, readable ANSI/CP437 display, gameplay, and a clean return to the BBS. Reconnect and check the same profile is loaded. Also test an interrupted connection and, if applicable, two concurrent nodes with different callers and separate dropfiles. Do not treat local mode as proof that these remote behaviors work on your installation.
3. Set policy and optional services
Fresh installs use these defaults; upgrades retain your existing choices:
| Setting | Default and meaning |
|---|---|
GENERAL.VisitsPerDay |
0: unlimited visits per player per day |
GENERAL.RunsPerDay |
0: unlimited runs per character profile per day, across visits |
GENERAL.ResetDay |
2: Monday weekly-score reset (1 is Sunday) |
GENERAL.LogLevel |
2: informational logging |
GENERAL.LogRetentionMinutes |
4320: three days; 0 disables pruning |
GENERAL.Blink |
-1: auto-detect; 0 uses reverse video, 1 forces ANSI blink |
LEADERBOARD.Enabled |
0: global result export disabled |
BALANCE_TELEMETRY.Enabled |
1: local pseudonymous balance-event collection enabled |
Set positive visit/run limits if desired. The README lists every shipped INI
key; baud300.ini.defaults is the canonical default configuration.
Optional global leaderboard
Local play does not require a leaderboard account or an Internet connection. The Global tab reads a local cache; it is populated by the separate uploader. Obtain the HTTPS service URL, installation UUID, and secret from the leaderboard service operator. Review the telemetry choice below before uploading. Then run from the game directory:
leaderboard-upload --configure
leaderboard-upload --tls-status
leaderboard-upload --once
leaderboard-upload --status
--configure prompts for those three values and enables global result export
in baud300.ini. Start new game sessions after configuring it. Follow the
step-by-step setup and verification in LEADERBOARD_UPLOAD.md.
On Linux prefix the executable with ./. After provisioning, Windows sysops
can schedule leaderboard-maintenance.bat in a BBS maintenance event or Task
Scheduler. On Linux, schedule a command that first changes directory, such as:
cd /opt/300-baud && ./leaderboard-upload --once
Windows uses native WinHTTP/SChannel; Linux uploads need a compatible OpenSSL
runtime. The game itself does not make outbound HTTP requests. See
LEADERBOARD_UPLOAD.md for setup, TLS, queues, and recovery.
An unconfigured uploader may report InstallationId must be a UUID; this does
not prevent local play. Do not enable result export with an invented UUID.
Telemetry choice
Review BALANCE_TELEMETRY.md before enabling maintenance
uploads. Telemetry is an installation-wide sysop choice, enabled by default;
players are not prompted. It omits handles and player IDs but may be correlatable
on a small BBS. Set [BALANCE_TELEMETRY] Enabled=0 to stop new event collection
on subsequent game launches. Existing queued events remain; disabling collection
does not delete or recall them. The separate uploader transmits queued events.
Upgrading and backing up
- Disable the door entry and stop active game and uploader processes. Back up
the complete installation, especially
baud300.ini,data/(includingplayers.datand the uploader credential), and any customized assets. - Extract the new matching-platform package into the existing game directory,
keeping its directory layout. Packages contain defaults, not a live INI.
Run
install-or-upgrade.baton Windows or./config-upgradeon Linux. The merger adds missing keys, preserves values/comments, and makes a timestampedbaud300.ini.bak.*backup when updating an existing file. - Review the changelog, test local and remote launch, then reopen the door.
Preserve
data/; deleting it discards player progress and service state. For rollback, restore the complete pre-upgrade backup while the door is closed.
Keep data/leaderboard-upload.ini private: it contains the uploader secret.
Configuration merging never changes that credential file. Archive backups
outside publicly downloadable directories. Inspect logs/ and queue growth as
part of maintenance; uploader outboxes are append-only, not automatically emptied.
Troubleshooting
| Symptom | Check |
|---|---|
| Binary will not start | Correct package architecture/OS, Linux execute permissions, and any loader error; do not use a Windows executable as a DOS door |
| Missing art, empty profiles, or unexpected defaults | Working directory, complete extraction, and read/write permissions under the BBS account |
| Dropfile missing or unsupported | Current node path, actual filename/case, quoting, and attached -D argument |
| Local login appears for a remote caller | Remove -L; check that the BBS passes the intended -D or socket arguments |
| Remote session hangs or disconnects | BBS transport mode and inherited connection handle; test the real launch, not a saved dropfile |
| Garbled borders or missing colors | Caller terminal's ANSI and CP437 settings, 80x24 display, and the INI Blink setting |
| Global scores absent | Provisioning, leaderboard-upload --status, TLS status, and a successful --once cache refresh |
When reporting a problem, include VERSION, BUILD-INFO.txt, OS/architecture,
BBS software/version, terminal client, sanitized launch command, and relevant
log messages. Never include the uploader secret or authentication headers.
Set up the global leaderboard on your own BBS
Use this setup when the native 300 Baud door is installed on your BBS. The
included leaderboard-upload executable handles uploads and downloads; Python
is not required. If you use the remote door, its operator handles this setup.
1. Get your installation credentials
Ask the leaderboard service operator to provision your BBS and supply all three:
- The HTTPS leaderboard service URL.
- Your installation UUID.
- Your installation secret.
These are issued for your installation. Do not invent a UUID, reuse another BBS's credentials, or substitute your remote-door connection secret. This guide does not include a public self-registration endpoint; obtain the assigned values from the service operator before continuing. Local play and local leaderboards work without them.
2. Configure the included uploader
Run these commands from the directory containing the installed game and assets. On Windows, in Command Prompt:
install-or-upgrade.bat
leaderboard-upload.exe --configure
On Linux:
./config-upgrade
./leaderboard-upload --configure
The upgrade tool creates or merges baud300.ini while preserving existing
settings. At the configuration prompts, enter the service URL, installation
UUID, and secret supplied by the operator. Run this in a private terminal;
do not share a recording or transcript containing the secret.
Successful configuration prints Leaderboard uploader configured. and sets
[LEADERBOARD] Enabled=1 and InstallationId in baud300.ini. The service URL
and secret are saved in data/leaderboard-upload.ini (mode 0600 on Unix).
Keep that file private and include it in private backups. Future configuration
upgrades preserve these values. Start new game sessions to load the settings.
3. Choose telemetry, then verify the connection
Before the first upload, review BALANCE_TELEMETRY.md. Telemetry collection defaults to enabled. The uploader sends queued telemetry as well as leaderboard results; disabling new collection does not remove any existing queue. The telemetry guide explains the operator controls.
On Windows:
leaderboard-upload.exe --tls-status
leaderboard-upload.exe --once
leaderboard-upload.exe --status
On Linux:
./leaderboard-upload --tls-status
./leaderboard-upload --once
./leaderboard-upload --status
--tls-status checks the HTTPS service without uploading game data. --once
uploads queued results and refreshes the Global leaderboard cache, even when
there are no pending victories. It must finish successfully. Open the game's
leaderboard screen and select Global to check the downloaded cache. A new
ruleset may legitimately have no scores yet.
4. Schedule maintenance and check a real victory
Use the Windows maintenance batch or Linux scheduled command in Scheduling
below. Run it under an account with permission to read the uploader credential
and update data/. It must run from the game installation directory.
After a player wins a complete run with export enabled, run maintenance and
check --status and the maintenance log. A successful upload acknowledges the
result; inspect data/leaderboard-rejected.jsonl if the service rejected it.
Only victories are submitted. Defeat, abandoned runs, and disconnects are not
leaderboard results. A submitted score appears in the Global top ten only if
it qualifies for that ruleset.
Setup troubleshooting
| Symptom | Action |
|---|---|
InstallationId must be a UUID |
Obtain the issued UUID and rerun --configure; local play still works |
| Secret or service URL missing | Run --configure from the correct game directory |
| TLS check fails | Check HTTPS URL, host connectivity, system clock and trusted certificates; on Linux also check the OpenSSL runtime |
| Upload rejected or unauthorized | Check the rejection/log message and confirm credentials with the service operator; do not post secrets or authentication headers |
| Global scores are stale | Run --once successfully and check the configured GlobalCachePath and write permissions |
| No result after a run | Confirm export was enabled when the game launched, the run ended in victory, and the correct installation's queue is being processed |
How result uploads work
baud300 and leaderboard-upload have deliberately separate responsibilities:
baud300 -> locked local JSONL append -> leaderboard-upload -> HTTPS service
The game links only the result serializer and outbox writer. Only victories are queued for leaderboard submission. Defeat, abandoned runs, and carrier loss bank no score; their optional aggregate gameplay telemetry is separate. It never loads the installation secret, opens a socket, retries, or waits for leaderboard service availability. A local append failure is written to the game log and does not prevent player exit.
The wire schema, authentication algorithm, and canonical cross-language
fixtures are owned by richorr/300-baud-leaderboard. This utility implements
schema version 1 and the /v1/results/bbs contract described there.
Commands
leaderboard-upload --once upload pending records and refresh the global cache
leaderboard-upload --status show total, acknowledged, pending, and malformed
leaderboard-upload --dry-run print the next exact body and auth headers; no network
leaderboard-upload --tls-status identify the TLS provider and test service health
leaderboard-upload --configure
The game and uploader share an outbox sidecar lock, so first-file creation,
single-line appends, and batch snapshots are serialized across BBS nodes.
--once also holds an exclusive uploader lock, submits at most 100 records per
request, and retries a network/5xx failure once. Accepted and duplicate result
IDs are appended to data/leaderboard-acknowledged.txt. Rejected IDs are also
acknowledged so they do not poison every later batch, and their reasons are
written to data/leaderboard-rejected.jsonl for operator review. The outbox is
append-only and is not truncated by the game or uploader.
Malformed JSON and records for a different installation are never sent. They
are reported by --status and must be corrected or moved aside by the sysop.
After processing the outbox, including when no results are pending, --once
downloads the top 10 all-time scores for the current ruleset from
GET /v1/leaderboards. It validates the response and writes the locked cache
configured by LEADERBOARD.GlobalCachePath. The game's Global tab reads only
that local file. A network or validation failure preserves the previous cache
and returns a non-zero uploader exit status.
The same scheduled invocation reads opted-in combat events from
data/balance-outbox.jsonl and sector/run summaries from
data/gameplay-outbox.jsonl. It submits them in separate batches of at most 25
to /v1/telemetry/combat/bbs and /v2/telemetry/gameplay/bbs; the signed path
and schema version therefore remain unambiguous. Each queue has a separate
acknowledgement and rejected-event ledger. See BALANCE_TELEMETRY.md for the
privacy boundary. Telemetry delivery failures leave events queued and emit a
warning, but do not block result uploads or global-cache refreshes.
Authentication and TLS
The utility signs the SHA-256 hash of the exact compact batch body using the
service-defined HMAC-SHA256 construction. The secret is never sent. Remote
service URLs must use HTTPS; plain HTTP is accepted only for localhost and
127.0.0.1 conformance tests.
On Windows, HTTPS uses the operating system's WinHTTP/SChannel implementation
with TLS 1.2 and normal certificate validation. No OpenSSL DLLs are required.
On Linux and macOS, HTTPS uses Free Pascal's fphttpclient and
opensslsockets, which require a compatible OpenSSL runtime. Run
leaderboard-upload --tls-status after configuration to identify the selected
provider and make a certificate-verified request to the service health endpoint
without uploading queued data.
Scheduling
Run --configure once when installing the connection, and again only when the
service URL or installation credential changes. --dry-run, --status, and
--tls-status are optional diagnostics.
On Windows, add this command to the BBS maintenance event or Windows Task Scheduler:
leaderboard-maintenance.bat
Keep the batch file beside baud300.ini and leaderboard-upload.exe. It
changes to that directory, creates data when needed, runs only --once,
writes the latest run to data\leaderboard-upload.log, and returns the uploader
exit code to the maintenance runner. No player session waits for this task.
For Windows Task Scheduler, set Program/script to the full path of
leaderboard-maintenance.bat. No arguments or separate Start in directory
are required.
On Unix-like systems, run one process daily or at another interval appropriate for the BBS. Example:
17 4 * * * cd /opt/300-baud && ./leaderboard-upload --once >> data/leaderboard-upload.log 2>&1
For systemd timers or a BBS event runner, set the working directory to the
installation directory and invoke --once. Multiple overlapping invocations
are safe: all but the lock owner exit with status 2.
Exit status is 0 for success/no pending work, 1 for upload or persistence failure, and 2 for configuration, usage, or uploader-lock errors.
Pseudonymous Balance Telemetry
Balance telemetry is a sysop-only, installation-wide choice made in
baud300.ini. It defaults to enabled. Players are not asked and cannot opt
out individually; there is no per-player telemetry preference or record.
Uploaded game data
Every completed combat produces the existing combat.resolved schema-v1
event. Its raw code-box results supply enemy, Crack, and Phreak denominators;
win ratios are derived by the service rather than sent by the game. The
decision keeps the original rolled values and types intact, while a separate
exploit object identifies PATCH, SPOOF, or SHUNT and records the affected
slots before and after the transformation.
Every completed sector also produces a schema-v2 sector.resolved summary:
- sector order, character, sector, ascension, turns, and outcome
- starting, ending, peak, generated, cooled, advanced, and carried pursuit
- grace, diversion, and cadence holds
- scanner type, bandwidth dwell, operations, locks, and fires
- mutually exclusive frozen hits, zero-turn hits, and misses
- assigned/served frozen turns and captures while frozen
At run end, run.resolved records completion, total turns, combat attempts and
wins, a coarse duration bucket, and coarse credit bands after the run-start cap
and at run end. It also records a coarse signed in-run net-change band, whether
the cap was applied, and a coarse band for credits discarded. Counting events where
capApplied is true gives the number of run-start reductions. A player who
declines the confirmation creates no run event and no cap application. It has no
timestamp or run-wide join key. Sector events use a new random ID for that
sector only.
The nested credits object uses schemaVersion: 1, independently of the run
event's top-level schema version, so its fields can evolve without changing
unrelated run telemetry.
Events do not contain handles, player/account IDs, IP addresses, free text, maps, leaderboard result IDs, or installation IDs. The uploader's authenticated request identifies the provisioned BBS to the service, but that identity is not stored with gameplay events.
The combination of character, sector, ascension, outcome, and final layer may still correlate to a named leaderboard result on a small BBS. This stream is therefore pseudonymous by correlation, not anonymous. The service contract requires raw events to be deleted after 180 days and forbids using telemetry for leaderboard verification.
Local flow
[BALANCE_TELEMETRY] Enabled=1
-> data/balance-outbox.jsonl (combat v1)
-> data/gameplay-outbox.jsonl (sector/run v2)
-> leaderboard-upload scheduled batch
-> /v1/telemetry/combat/bbs and /v2/telemetry/gameplay/bbs
The game performs no network access. Each event is appended under a short file lock; if the append fails, gameplay continues and the failure is logged. The separate queues preserve compatibility with old combat uploaders and let each signed request use one schema version and exact path.
leaderboard-upload --status reports combat and gameplay queue totals,
acknowledgements, pending events, and malformed events. --once uploads both
queues after leaderboard results. Failures are warnings and remain queued for
the next BBS maintenance run.
Operator controls
[BALANCE_TELEMETRY] Enabled defaults to 1. Set it to 0 to stop creating
new events for the entire installation. Existing queued events remain local
until the operator archives or uploads them. The flag takes effect after the
next game restart and does not recall already uploaded events.
The default paths are:
[BALANCE_TELEMETRY]
Enabled=1
OutboxPath=data/balance-outbox.jsonl
GameplayOutboxPath=data/gameplay-outbox.jsonl