Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.5 KB

README.md

File metadata and controls

61 lines (39 loc) · 2.5 KB

Cosmic Crew: Dusk

CI Release

Cosmic Crew: Dusk is will be a conceptual, 3d interplanitary base building game. The main inspiration comes from the "Space Kit" free assets found at kenny.nl/assets/space-kit. NOTE: This project is in an extraordinarily early stage, and the idea, concept and any related content is subject to drastic change and modification.


Download & play

To run and play Cosmic Crew: Dusk, there are a few options:

Releases

  1. By downloading either a specifc release or 'nightly version of the game from the github releases page
  2. Extracting the archive (if necessary)
  3. Running or opening the executable

From source

  1. Install rust at rustup.rs
  2. Clone the repo git clone https://github.com/cosmiccrew/dusk.git
  3. cd dusk
  4. cargo run or (for increased runtime performance, but longer compile times) cargo run --release

Contributing

Any and all contributions are welcome! Pull requests are checked for cargo test, cargo clippy and cargo +nightly fmt. Note this project uses unstable cargo fmt settings, and requires installing and running cargo fmt on the nighlty edition.

Before submitting a PR or issue, please run the following commands and follow their instructions:

  1. cargo clippy
  2. cargo +nightly fmt

Dev builds

The development build by default has some runtime performance improvements enabled - however, to speed up compile times (namely using bevy's internal dynamic linking feature), a simple feature flag can be enabled:

cargo run --features dynamic_linking

You may want to create a Makefile, shell alias, or other similar script runner (e.g. Just) for this. please note: this will decrease some runtime performance.


License

Licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.