Skip to content

Commit

Permalink
Disable prune since it's currently broken, improve readme (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
shanemadden authored Dec 5, 2022
1 parent 19235b5 commit 750bb6c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 16 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# screeps-starter-rust
# screeps-arena-starter-rust

Starter Rust AI for [Screeps][screeps], the JavaScript-based MMO game.
Starter Rust AI for [Screeps: Arena][screeps-arena], the JavaScript-based programming
strategy game.

This uses the [`screeps-game-api`] bindings from the [rustyscreeps] organization.
This uses the [`screeps-arena-game-api`] bindings from the [rustyscreeps] organization.

It's also recommended to use [`cargo-screeps`] for uploading the code.
It's also recommended to use [`cargo-screeps`] for building the code.

The documentation is currently a bit sparse. API docs which list functions one
can use are located at https://docs.rs/screeps-game-api/.
can use are located at https://docs.rs/screeps-arena-game-api/.

Almost all crates on https://crates.io/ are usable (only things which interact with OS
apis are broken).
Expand All @@ -18,8 +19,8 @@ Quickstart:
# cli dependencies:
# TEMPORARY - get the arena branch of the cargo-screeps tool, which supports arena
git clone https://github.com/rustyscreeps/cargo-screeps.git
git checkout arena
cd cargo-screeps
git checkout arena
cargo install --path .
cd ..
# TEMPORARY once arena is merged, go back to simply:
Expand All @@ -28,22 +29,20 @@ cargo install cargo-screeps
# clone:
git clone https://github.com/rustyscreeps/screeps-arena-starter-rust.git
cd screeps-starter-rust
# TEMPORARY
git checkout arena

# configure for uploading:
# configure with the path to your arena code directory:
cp example-screeps.toml screeps.toml
nano screeps.toml

# build tool:
cargo screeps --help
# compile the module
cargo screeps build
# compile plus deploy to the configured 'ctf' mode
cargo screeps deploy -m ctf
# compile plus deploy code to the game directory for the Swamp & Spawn arena
cargo screeps deploy -m swamp
```

[screeps]: https://screeps.com/
[screeps-arena]: https://store.steampowered.com/app/1137320/Screeps_Arena/
[`cargo-screeps`]: https://github.com/rustyscreeps/cargo-screeps/
[`screeps-game-api`]: https://github.com/rustyscreeps/screeps-game-api/
[`screeps-arena-game-api`]: https://github.com/rustyscreeps/screeps-arena-game-api/
[rustyscreeps]: https://github.com/rustyscreeps/
6 changes: 3 additions & 3 deletions example-screeps.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ build_mode = "arena"

[ctf]
destination = "/Users/username/ScreepsArena"
prune = true
prune = false
branch = "alpha-capture_the_flag"
[ctf.build]
extra_options = ["--features=arena-capture-the-flag"]

[swamp]
destination = "/Users/username/ScreepsArena"
prune = true
prune = false
branch = "alpha-spawn_and_swamp"
[swamp.build]
extra_options = ["--features=arena-spawn-and-swamp"]

[collect]
destination = "/Users/username/ScreepsArena"
prune = true
prune = false
branch = "alpha-collect_and_control"
[collect.build]
extra_options = ["--features=arena-collect-and-control"]
Expand Down

0 comments on commit 750bb6c

Please sign in to comment.