Rhombus

Next generation extendable CTF framework with batteries included.

See documentation for deployment, and a hosted demo.

Development

The MSRV is currently 1.80.0.

Nix (recommended)

A Nix Flake is provided for development. It is recommended to be paired with direnv for automatic environment setup.

Individual dependencies

Required:

• Rust
• Deno

Optional (recommended):

• mold
• cargo-watch
• Task

Getting started

Run task dev to start the standalone example. This will build the project and start the server with live reloading.

Project structure

├── rhombus/             # core library
│   ├── src/             # rust source code
│   ├── templates/       # minijinja templates
│   ├── static/          # static files like css, js
│   ├── frontend/        # TypeScript source code
│   ├── migrations/      # SQL database migrations
│   ├── locales/         # translations for the UI
├── rhombus-cli/         # CLI tool to manage and play CTFs
├── rhombus-shared/      # code shared by rhombus-cli and rhombus
├── rhombus-build/       # core library for build scripts
├── docs/                # hosted docs on https://rhombus.gg
└── examples/
    ├── standalone/      # minimal example
    ├── demo/            # demo running https://demo.rhombus.gg
    ├── plugin/          # example plugin library
    ├── external-plugin/ # uses `plugin` as a dependency
    └── custom-grpc/     # a plugin that adds custom GRPC methods