style
esc
  • Loading…

Start hereAxiom Style Guide template

How to write, test, package and ship plugins, game providers and language providers for the Axiom universal modding framework.

C ABIWASM · .NETProviders

A ready-to-build Rust/WASM Axiom plugin with the guide's manifest, layout and lifecycle, a sample low-health warning, unit and mock-host lifecycle tests beside the code, and a cross-platform CI workflow that lints, tests and packs the .axmod.

  1. 1

    Download

    Pick a plugin name, your author handle and the game id. The plugin id, crate, .wasm entry and Rust type are renamed for you.

  2. 2

    Set up

    Install rustup and the Axiom CLI; the pinned toolchain installs itself. Run cargo generate-lockfile and commit Cargo.lock.

  3. 3

    Build and test

    Run cargo test and axiom test, then axiom build and axiom pack to produce the .axmod.

What you get

better-minimap/
├── .github/
│   └── workflows/
│       └── ci.yml
├── assets/
├── config/
│   └── default.toml
├── src/
│   ├── lib.rs
│   ├── lib.test.rs
│   ├── low_health.rs
│   └── low_health.test.rs
├── .gitignore
├── axiom.toml
├── Cargo.toml
├── CHANGELOG.md
├── LICENSE
├── README.md
└── rust-toolchain.toml