Skip to content

Zaechus/kingslayer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

👑 Kingslayer ⚔️

CI Crates.io Kingslayer documentation

Kingslayer is a text-based dungeon crawler written in Rust. It is a continuation of thekinggame.

Playing the game

You can play an online WASM version here: zaechus.github.io/kingslayer-web

You can also install Kingslayer:

cargo install kingslayer
kingslayer

or clone the project and run it:

cargo run --release

Creating and running your own world

Worlds can be created with RON and Rust helper functions. Running a specific world on the command line looks like this:

kingslayer [FILE]

or with your own Rust code:

use kingslayer::Cli;

fn main() {
    let cli = Cli::from_file("worlds/world.ron");

    cli.start();
}

The game loop can also be managed manually like this:

use kingslayer::Cli;

fn main() {
    let cli = Cli::from_file("worlds/world.ron");

    println!("{}", cli.ask("l"));
    loop {
        let s = cli.ask(&Cli::prompt());
        println!("{}", s);
        if s.contains("Farewell.") {
            break;
        }
    }
}

This method allows for other forms of input and output such as within a website. The content for the world can also be passed as a raw string with Cli::from_ron_str.

Dependencies

  • Rust/Cargo ^1.59.0