Skip to content
Permalink
master
Switch branches/tags

cardboard/README.md

Go to file
 
 
Cannot retrieve contributors at this time
Cardboard Engine / Carmine Impact Supported Systems Build instructions Windows Mac Linux Contributing License
59 lines (45 sloc) 1.73 KB
Raw Blame

Cardboard Engine / Carmine Impact

A live copy of our game engine, the Cardboard Engine! Based on the fantastic Cube 2 game engine.

It currently also houses the source for Carmine Impact, as it's deeply rooted within the engine itself.

Supported Systems

Windows: ✓ | Mac: ❌ | Linux: ✓ (build required)

Build instructions

Windows

  • Build with Visual Studio 2019, msbuild should also work.

Mac

Coming sooner than you might think.

Developing for M1 is cringe, I hate my life.

Linux

  • Get dependencies (make and git are not included in the list, as they should be installed on your system already.)

Ubuntu/Debian:

sudo apt-get update
sudo apt-get install -y libsdl2-dev libsdl2-mixer-dev libsdl2-image-dev libsdl2-ttf-dev libcurl4-openssl-dev libenet-dev

Arch/Manjaro:

sudo pacman -S sdl2 sdl2_mixer sdl2_image sdl2_ttf curl enet
  • Get source code from latest tagged GitHub release
git clone --recursive https://github.com/HarpNetStudios/cardboard.git
cd cardboard
git checkout $(git describe --tags)
  • Start the build process
cmake CMakeLists.txt
make
make install

  • Open cardboard_unix (in the root directory) with your favorite text editor, and replace -cOFFLINE with -c{your game token} Confused? Check here!

  • And lastly, run chmod +x cardboard_unix and ./cardboard_unix to start it

Contributing

Github Issues is the best way to report bugs, as well as reporting them in the official Discord server.

License

The Cardboard engine is licensed under the zlib license. Please refer to the license folder for more info.