TrainEngine

Cross-platform 2D game engine made with C++ and SFML.

Features

• Game state management
• Multimedia resource manager
• Input manager (with both callbacks and polling support)
• Frame interpolation
• Multi-view camera
• Animated entities
• Parallax
• GUI
• Tilemap level editor
• Physics
• Profiling information

Prerequisites

Toolchain

• GCC or Clang

  Note: for Windows, make sure you have MinGW-w64 SEH 6.1.0 64-bit installed and in your PATH. This version is important since SFML's binaries are shipped with the engine. If you want to use a different compiler, you must recompile SFML 2.4.2 and replace it in the engine under libs/SFML-2.4.2.

• Make

  Note: for Windows, you should use Git Bash (shipped with Git for Windows). Use mingw32-make instead of make.

• clang-format
• clang-tidy
• Doxygen and Graphviz

Dependencies

• SFML 2.4.2 or 2.5.1:
  • Linux: install SFML using your system's package manager. For example: sudo apt install libsfml-dev.
  • macOS: install SFML using the instructions here.
  • Windows: building for Windows will use the vendored SFML library under libs/SFML-2.4.2.

Usage

Building

make

Running

make copyassets run

Formatting

make format

Linting

make lint

Cleaning

make clean

More information

$ make help
Usage: make target... [options]...

Targets:
  all             Build executable (debug mode by default) (default target)
  install         Install packaged program to desktop (debug mode by default)
  run             Build and run executable (debug mode by default)
  copyassets      Copy assets to executable directory for selected platform and configuration
  cleanassets     Clean assets from executable directories (all platforms)
  clean           Clean build and bin directories (all platforms)
  compdb          Generate JSON compilation database (compile_commands.json)
  format          Format source code using clang-format
  format-check    Check that source code is formatted using clang-format
  lint            Lint source code using clang-tidy
  lint-fix        Lint and fix source code using clang-tidy
  docs            Generate documentation with Doxygen
  help            Print this information
  printvars       Print Makefile variables for debugging

Options:
  release=1       Run target using release configuration rather than debug
  win32=1         Build for 32-bit Windows (valid when built on Windows only)
  ios=1           Build for iOS (valid when built on macOS only)

Note: the above options affect the all, install, run, copyassets, compdb, and printvars targets

Documentation

Documentation can be generated using Doxygen:

make docs

The docs can then be read in HTML format by opening docs/html/index.html with a web browser.

License

MIT