Skip to content

corewa-rs/corewars

Repository files navigation

corewars

Latest Github release Build status

Latest corewars release Latest corewars-core release Latest corewars-parser release Latest corewars-sim release

A Rust implementation of the classic programming battle game Core Wars.

The implementation is based on this introductory guide to Redcode, as well as the pMARS '94 reference and an annotated version of the ICWS '94 draft.

Quick start (command line)

First install cargo via rustup.

$ cargo install corewars
...
Installed package `corewars v0.2.0` (executable `corewars`)

$ ~/.cargo/bin/corewars --version
corewars 0.2.0

Cargo Crates

Latest documentation (incomplete) is published from develop, with older version docs available on docs.rs.

  • corewars: the binary to run Core Wars from the command line.
  • corewars-core: data structures and utilities common to other crates (such as the representation of a "core").
  • corewars-parser: the parser used to read and error-check Redcode files. Output from this crate will be used as input for the MARS simulation itself.
  • corewars-sim: simulation of a core. This is the main logic used to pit warriors against one another (the MARS).

Other tools

  • A VSCode syntax highlighting plugin for Redcode