Skip to content

Latest commit

 

History

History
92 lines (55 loc) · 2.42 KB

README.md

File metadata and controls

92 lines (55 loc) · 2.42 KB

Rally MKA Go Report Card Go Reference

Rally MKA is a really old game/demo of mine ported to Go for fun and as a way to experiment with new concepts. It is also a showcase for the lacking game engine.

Game Screenshot

User's Guide

Browser

You can play the game on itch.io.

The preferred browser is Chrome, which at the time of writing appears to best support WebGL2, WebAssembly and Game Controllers.

Desktop

Check the Releases section for ready-to-use binaries that you can use on your computer.

The requirement is that your OS supports OpenGL 4.6.

Developer's Guide

This section describes how to setup the project on your machine and compile it yourself.

Prerequisites

  • You need Go 1.20 or newer.
  • You need the Git LFS plugin. As the project contains large images and models, this is the official way on how not to clog a repository.
  • Follow the instructions on the GLFW for Go repository and make sure you can run the GLFW examples on your platform.
  • Make sure you have Task installed, as this project uses Taskfiles.

Setting Up

  1. Clone the repository

    git clone https://github.com/mokiat/rally-mka
    cd rally-mka
  2. Download Go dependencies

    go mod download
  3. Generate game assets

    task pack

Desktop

  1. Run the game

    task run

Browser

  1. Generate web content

    task webpack
  2. Build web assembly executable

    task wasm
  3. Run an HTTP server

    task web
  4. Open http://localhost:8080

Licensing

Code

All source code in this project is licensed under Apache License v2.

Assets

Assets (images, models, textures, etc.) are distributed under the Creative Commons Attribution 4.0 International license.