Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 2.41 KB

README.md

File metadata and controls

70 lines (49 loc) · 2.41 KB

screeps-game-api

Linux Build Status crates.io version badge docs.rs version badge

Rusty Screeps Logo

Typed bindings to the Screeps in-game API for WASM Rust AIs.

Also the homepage for tools relating to writing Screeps AIs in Rust.

screeps-game-api is a Rust binding to the JavaScript APIs for programs compiled to WASM using stdweb.

Also in this organization is cargo screeps, a binary program which wraps cargo web and lets one directly upload Rust WASM code to Screeps servers.

These two tools go together well, but do not depend on eachother. cargo-screeps can compile and upload any screeps WASM project buildable with stdweb's cargo-web, and screeps-game-api is usable in any project built with cargo-web.

Writing Screeps code in Rust can be nice, but it can also be annoying. If you have tips, tricks, or other things you'd like to share, make an issue! We need to write more documentation, and if we have enough ideas, we can start an mdbook for this repository.

If you need help or want to share feedback, feel free to open an issue or come say "Hi!" on the official Screeps Slack in the #rust-wasm channel!


Here's a quickstart for what you need to get going. More documentation will be made in the future.

# clone:

git clone https://github.com/rustyscreeps/screeps-starter-rust.git
cd screeps-starter-rust

# cli dependencies:

cargo install cargo-screeps

# configure for uploading:

cp example-screeps.toml screeps.toml
nano screeps.toml

# build tool:

cargo screeps --help