Skip to content

K4ugummi/carambolage

Repository files navigation

Carambolage

logo small Build Status License: GPL v3

Contents

  1. License
  2. Download
  3. Build
  4. Contributing
  5. Just saying thank you

A game written in Rust!

screenshot (Click on this screenshot to be redirected to a gameplay video on Youtube)

Controls

controls Open Menu: [Esc]

Player 1
movement: [W],[A],[S],[D]
boost: [Left Shift]

Player 2
movement: [Up],[Left],[Down],[Right]
boost: [Right Shift]


License

Carambolage is licensed under GNU General Public License v3


Download

No precompiled binaries yet ¯\_(ツ)_/¯

Build yourself

  1. Download and install the Rust-lang compiler.
  2. You have to setup GLFW on your system in order to build the game, because it handles a the OpenGL context window for your platform.
  3. Clone this repository git clone https://github.com/K4ugummi/carambolage.git
  4. cd carambolage
  5. Build and run the game cargo run --release

Contributing

  1. Fork the project
  2. Create a new branch git checkout -b <branch>
  3. Make changes
  4. Run cargo fmt
  5. Run cargo clippy and make sure it compiles wihtout warnings.
  6. Push your changes to your fork and create a pull request

A huge thanks to

  • The Rust Team
  • Joey de Vries Author of learnopengl.com
  • YOU for spending your time reading this readme, playing the game or even contributing to the project!