🌸 Blossom

Blossom is an opinionated MUD engine written in Rust.

This is still a VERY early work-in-progress and there will be sweeping, breaking changes constantly as I refine the architecture and API. If you actually want to build a MUD, you'd be best off using an existing codebase. Any of the old C-bases, Evennia (Python), or Ranvier (JavaScript) are excellent options.

Live Game

Secure: blossom-engine.com:5443 Unsecure: blossom-engine.com:5080

The server should be online most of the time. If it is not, I am probably updating and it should be back momentarily.

It is recommended to always connect with the secure connection. Your traffic will be encrypted with modern TLS. You will, of course, need an actual MUD client to connect securely. If you are using old-school telnet, you will have to use the unsecure connection.

Usage

// main.rs
use blossom::prelude::*;

fn main() -> Result<(), Box dyn std::error::Error>> {
    let server = Server::new();
    let world = World::new();

    server.listen(world)?;

    Ok(())
}

This is a minimal working example; it has no game content. If you want to see the code and game data for Coven, the example game above, it is also open-source.

Contributing

Prerequesites:

Rust 1.60 (nightly; Blossom uses some nightly-only features)
PostgreSQL 14
(optional) Python 3 (tooling)
(optional) SQLx CLI (migrations)

git clone https://github.com/robertwayne/blossom
Modify the .env.TEMPLATE file in the root directory with your local Postgres details. (This is neccesary for SQLx to do compile-time SQL validation).
(requires SQLx CLI) From the root directory, run sqlx migrate run to apply the schema.
Hack away!
Run ./check.sh before you open a PR.

By contributing, you agree that any code submitted by you shall be dual-licensed under MIT and Apache-2.0.

License

Blossom source code is dual-licensed under either

MIT License
Apache License, Version 2.0

at your option.

Comments

Compile time improvements
shrunk dependencies where possible

tightened features on dependencies (like tokio)

fixed the dylib feature

Hot compile times are usually under 3 seconds downstream (as low as sub-1 second), which is okay.
opened by robertwayne 0
Implement initial framework for the web server

When the game server is being setup, an axum-based server will now spawn in the background as a Tokio task. This will, eventually, be an administration/moderation panel, analytics and status dashboard, the content creation tools (map builder, script editor, etc.), and logging.

A lot of that still needs planning, but the first things to add will likely be authentication (simple - no sign up, just log in tied to the game database accounts) and an account/player editor.

opened by robertwayne 0