https://github.com/karnkaul/ledemo
Demo Game on 2D C++17 engine using PhysicsFS and SFML
https://github.com/karnkaul/ledemo
cmake cpp cpp17 game game-engine linux opengl physfs sfml win64
Last synced: about 2 months ago
JSON representation
Demo Game on 2D C++17 engine using PhysicsFS and SFML
- Host: GitHub
- URL: https://github.com/karnkaul/ledemo
- Owner: karnkaul
- License: gpl-3.0
- Created: 2019-11-02T23:54:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-05T01:48:17.000Z (over 6 years ago)
- Last Synced: 2025-06-01T23:57:03.864Z (about 1 year ago)
- Topics: cmake, cpp, cpp17, game, game-engine, linux, opengl, physfs, sfml, win64
- Language: C++
- Homepage:
- Size: 392 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Little Engine Demo
Written in **C++17**, utilising [**SFML**](https://www.sfml-dev.org/) and [**PhysicsFS**](https://icculus.org/physfs/), [Little Engine](https://github.com/karnkaul/LittleEngine) is a 2D game engine hobby project with little defined ambition or scope; and this repository demonstrates an example game using it.
[](https://travis-ci.org/karnkaul/LEDemo) [](LICENSE) [](https://twitter.com/KarnKaul)
>*Note: Visit the LittleEngine submodule [here](https://github.com/karnkaul/LittleEngine)!*
### Installation
LEDemo pre-releases containing a demo game with Win64, Linux-x64, Linux-ARMv8 binaries can be found [here](https://github.com/karnkaul/LEDemo/releases).
#### Requirements
1. x64 CPU with at least two threads
1. Git submodules (CMake scripts will update them automatically, and will fail to configure otherwise)
1. (Optional) Python 3.5+ (for `installer.py`)
1. Operating System:
1. Windows 7/8/10: [Microsoft VC++ Runtime (x64)](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
1. Linux: OpenAL libraries (`libopenal-dev`)
1. MacOSX: Python 3 (app bundles are unsigned; `installer.py` eases the UX)
#### Installing LEDemo
1. Obtain the game zip (present inside a [GitHub Release](https://github.com/karnkaul/LEDemo/releases) zip)
1. Unzip it to the installation directory and run `installer.py` via Python 3 (or unzip ".game" manually and copy the contents of "[Your OS]" into the installation directory)
> *Note: OSX builds are in alpha and may not be stable.*
### Development
Visit the [Little Engine wiki](https://github.com/karnkaul/LittleEngine/wiki/Development) for more detailed and per-platform instructions. `LEDemo` or any other game project just needs to add `LittleEngine` as a library dependency, setup game initialisation through the API (and global variables) in `GameLoop`, and return `GameLoop::Run()` to the OS.
#### Requirements
1. x64 (ARMv8 is supported but not packaged) multi-threaded target
1. [CMake](https://cmake.org/download/) for the target, preferably using [Ninja](https://ninja-build.org/) and [LLVM](https://llvm.org/)
1. [SFML 2.5.1](https://www.sfml-dev.org/download/sfml/2.5.1/) source / internet access (CMake will download it)
1. (Linux) libstdc++-7; all SFML dependencies (X11, Xrandr, OpenGL, UDev, Freetype, Vorbis, Flac, etc)
1. (Win 10) [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk) for ninja/MSBuild / Clang/VC++ or [MinGW](http://www.mingw.org/) for MinGW / g++
1. (MacOSX) Xcode
1. (Optional) Bash (native/MinGW/WSL), [Python 3](https://www.python.org/downloads/) (all tools scripts are in Bash/Python)
#### Setting up the project(s)
Quick Start:
1. Build `LEDemo`
1. CMake: generate a project using `CMakeLists.txt`
1. Build
1. Run `LEDemo`
1. Set working directory to `Runtime`
1. Debug/run the built/installed executable
[Short video](https://youtu.be/wwEubcOixGE) demonstrating full project setup from scratch on Linux (v0.5.0.0).
#### Troubleshooting
**"openal32.dll not found"**
**"Could not determine Runtime path" Assert**
Ensure working directory is "Runtime" for the `App` target.
**"Default font is null" Assert**
Ensure `Resources` submodule is up-to-date, and `GameAssets/Fonts/Default.ttf` is present.
### Contact
* [Twitter](https://twitter.com/KarnKaul)
### Licence
LEDemo uses the [GNU GPLv3 licence](LICENSE).
>*Note: Code of Conduct can be found [here](CODE_OF_CONDUCT).*