sdaveb/elemental-game
sdaveb/elemental-game
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects 1 Releases Wiki Activity
A game and custom-built game engine designed for creating simple, top-down strategy games.
120 Commits 2 Branches 1 Tag 1.5 MiB
C++ 86.5%
CMake 6.9%
Vim Script 3.3%
Shell 2.5%
JavaScript 0.8%
d71d22025d
Go to file
S David d71d22025d Add some support for VSCode w/ CMake extension
2024-03-07 10:11:22 -05:00
.vscode Add some support for VSCode w/ CMake extension 2024-03-07 10:11:22 -05:00
apps Doxygen consistency: use \{ and \} as region markers and vim foldmarker 2024-03-03 14:35:08 -05:00
data Add test rendering image and include licensing info 2024-01-03 23:55:25 -05:00
demo Modify enum constant naming convention base don how the enums are used 2024-02-29 09:39:14 -05:00
editorconfig Modify enum constant naming convention base don how the enums are used 2024-02-29 09:39:14 -05:00
include SdlEventSource: Do joystick init in constructor. 2024-03-06 23:32:06 -05:00
scripts Modernize codebase using clant-tidy modernization checks 2024-02-26 14:57:56 -05:00
src SdlEventSource: Do joystick init in constructor. 2024-03-06 23:32:06 -05:00
tests clangd fix: add a #define for language server clangd, so it can lint *all* code 2024-03-01 13:58:48 -05:00
.clang-format Run all code through clang-tidy and enforce consistent readable codestyle 2024-02-26 00:18:40 -05:00
.clang-tidy SdlEventSource: Do joystick init in constructor. 2024-03-06 23:32:06 -05:00
.clangd clangd fix: add a #define for language server clangd, so it can lint *all* code 2024-03-01 13:58:48 -05:00
.gitattributes Add .gitattributes for more accurate code statistics on gittea 2023-12-12 23:25:53 -05:00
.gitignore Large scale effort to wrap SDL_Renderer 2D hardware accelerated API. 2023-12-28 18:29:40 -05:00
CMakeLists.txt Naming convention enforcement and other improvements 2024-02-25 09:21:45 -05:00
Doxyfile Update doxyfile, .clang_format settings, fix doxygen warnings 2024-01-29 11:41:50 -05:00
LICENSE Fork project from template project. 2023-12-12 21:50:38 -05:00
README.md Fix: Correct required version of C++ in README.md 2024-01-17 18:46:13 -05:00

README.md

Elemental Game and Custom-built Game Engine

Welcome to Elemental Game, a game and custom-built game engine designed for creating simple, top-down strategy games. This README provides an overview of the project, its design principles, goals, and instructions for building and testing.

Getting Started

Build Tools

  • CMake (version 3.21 or higher)
  • C++17-compatible compiler

Project Structure

  • src/: Contains the engine logic, defines a libray target
  • apps/: Contains the game source, as well as source for resource editors, all consumers of the engine target
  • test/: Contains unit tests

Library Dependencies

  • Catch2 v3: Test framework for C++ (can be fetched using FetchContent).
  • FakeIt: Mocking framework for C++ (fetched using FetchContent).
  • SDL2: A cross-platform development library providing low-level access to audio, keyboard, mouse, and display functions.
  • SDL2_Image: An extension library for SDL2, offering support for loading various image file formats.
  • SDL2_Gfx: A graphics primitive extension library for SDL2, providing additional functionality for efficient graphics rendering.

Building the Project

  1. Clone the repository:

    git clone <URL>

  2. Navigate to the project directory:

    cd  elemental-game

  3. Configure your build system:

    cmake -B debug -G Unix Makefiles
# or
cmake -B debug -G Ninja   # this is faster and more modern

  4. Invoke your build system

    cmake --build debug

Running Unit Tests

  1. After building the project, you can run the unit tests:

    cmake --build --target ctest

This will execute the Catch2 test suite.

License

This project is licensed under the MPL 2.0 License.

Catch2, which is used for unit-testing is © Catch2 authors, and is licensed under the Boost Software License v1.0 FakeIt, is also used for unit-testing and is © Eran Pe'er and is licensed under the MIT License