An open API service indexing awesome lists of open source software.

https://github.com/aleksaheler/pixelgameengine-template-project

Template project to be used as starting point for olcPixelGameEngine
https://github.com/aleksaheler/pixelgameengine-template-project

olcpixelgameengine

Last synced: about 2 months ago
JSON representation

Template project to be used as starting point for olcPixelGameEngine

Awesome Lists containing this project

README

          

# How to set everything up

This is my template for One Lone Coder's [Pixel Game Engine](https://github.com/OneLoneCoder/olcPixelGameEngine). It's a nice platform for creating interactive games or applications in C++.

It's a basic project structure, using CMake to generate Makefile which is then used by make to build the executable.

## Installation

### Compiler

Download and install [MSYS2](https://www.msys2.org/).
Open MSYS2, and run command to update the package database and core packages by running: ```pacman -Syu```
Install GCC with: ```pacman -S mingw-w64-x86_64-toolchain```
This installs the full toolchain, including the gcc, g++, gdb (debugger), and make utilities.
Finally, add install directory "C:\msys64\mingw64\bin" to PATH environment variable.

### CMake

Download and install [CMake](https://cmake.org/download/).

## Project setup, file structure

```
project/
├─ env/
│ ├─ CMakeLists.txt - project define
├─ include/
│ ├─ olcPixelGameEngine.h - game engine library
├─ src/
│ ├─ main.cpp - entry point
│ ├─ main.h
├─ build.bat - runs CMake, and then MinGW make
├─ run.bat
├─ clean.bat
```