colonize

(β˜… 386)

A Dwarf Fortress/Rimworld-like game written in Rust

  • .clog.toml
  • .gitignore
  • .travis.yml
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • LICENSE
  • Makefile
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/indiv0/colonize

Downloads the entire project code from GitHub to your computer.

cd colonize

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
cargo install wasm-bindgen-cli

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
yarn install

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo run --release

Builds and then immediately runs the program.

cargo install wasm-bindgen-cli

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo build --release --target wasm32-unknown-unknown --no-default-features --features wasm

Compiles the Rust project.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make styles

Compiles the code based on the generated build configuration to produce an executable.

make serve

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation