33 lines
1.8 KiB
Markdown
33 lines
1.8 KiB
Markdown
# Blastmud
|
|
|
|
A component of a Rust-based mud (multi-user text-based game). Unlike many muds, it is designed to
|
|
be completely Free software (other than an age-verification file - see below), with the game
|
|
core written in Rust rather than in any form of softcode. Only user data forms part of the database.
|
|
Even the map is programmed in a normal text editor, and can be
|
|
tested locally before being deployed to the game.
|
|
|
|
# Architecture
|
|
|
|
Blastmud consists of the following main components:
|
|
* blastmud_listener is intended to be a long-running component that accepts connections from users. It can't be changed without disconnecting all users.
|
|
* blastmud_interfaces is a shared library defining the interface between the listener and the gameserver. It can't be changed without disconnecting all users.
|
|
* blastmud_game implements the gameserver. It does not hold any long-lived state, and so can be safely redeployed and replaced without disconnecting all users.
|
|
* A PostgreSQL database is used to store the entire state (user data) of the game. It is used with synchronous_commit turned off so that recently changed data is only stored in memory.
|
|
|
|
# Status
|
|
|
|
Blastmud is under active development, but is currently playable.
|
|
|
|
# Schema management
|
|
We only keep the latest version in version control, and use migra (pip3 install migra) to identify changes between
|
|
the production schema and the latest in code.
|
|
|
|
The latest schema is under `schema`.
|
|
|
|
Create a user with a secret password, and username `blast`. Create a production database called `blast`.
|
|
|
|
To get to the latest schema:
|
|
* Run `psql -d template1 <schema/schema.sql` to create the temporary `blast_schemaonly` database.
|
|
* Run `migra "postgresql:///blast" "postgresql:///blast_schemaonly" > /tmp/update.sql`
|
|
* Check `/tmp/update.sql` and if it looks good, apply it with `psql -U blast -d blast </tmp/update.sql`
|