Skip to content

Latest commit

 

History

History
55 lines (48 loc) · 4.58 KB

README.md

File metadata and controls

55 lines (48 loc) · 4.58 KB
Raw

Try2Engine

Cross-platform open-source 2D/3D game engine in the works.
Licensed under GPLv3 (and will continue to be), hence using it as a template or basis for other projects is permitted.
All libraries utilized in this project must be royalty free.

Read into the wiki for more info

module library description
Window SDL3 Initialize and create a window. Hook input, renderer, audio and others
2D Renderer SDL3* 2D images, textures, sprites, and in the future - tilemaps
3D Render ?? (TBD) Render 3D meshes, models, skeletons and or more
Audio ?? (TBD) Play and mix audio queues on demand
2D Asset loading STB_image SDL_Image Image loading
Input SDL3 Polling data sent from input devices; Connect/Disconnect, create and destroy controllers
Logger spdlog Logging messages, errors and more
GUI ImGui GUI for in-engine windows and widgets (object properties, settings modifications and others)
Tests gtest Testing of modules and logic
Build Tool CMake Building project on different platforms (tested on Linux Mint and Windows)
CMake Flag variations description
WITH_SDL TRUE/FALSE Build SDL3 based implementations in the project. There are a lot of facade and adapter implementations in the different source modules currently, due to which the majority of the project would require this flag to be 'TRUE' to build and run. You could still build a separate executable with this set to 'FALSE', ex. using only the 'Logger'.
Recommended 'TRUE'
WITH_IMGUI TRUE/FALSE Required to build the currently implemented GUI in the project.
Recommended 'TRUE'
WITH_SDL_IMAGE TRUE/FALSE Build the project with image loading with SDL_image. Strictly related to SDL2/3, and hard to build and run under Linux.
Recommended 'FALSE'
WITH_STB TRUE/FALSE Another image loading external library, currently implemented in the loader. Versatile, lighter and easier to build and run.
Recommended 'TRUE'
WITH_BOX2D TRUE/FALSE Includes BOX2D build dependencies and includes. Used in 'Try1' for now, later to be abstracted in a 'game/physics' module.
Recommended 'TRUE'

Build and run

  • Windows (tested on Windows 11):
    Requires a pre-installed CMake(3.15 and above) and a C++ compiler (ex. MSVC, GCC) with C++17 support.

    1. Choose a configuration - Debug or Release
    2. Run its corresponding batch file - GenerateAndBuild<Debug/Release>X64.bat , located in the root folder of the project 2.1 If building with Visual Studio - target the root CMakeLists.txt, which should automatically set the build target to 'tr1' executable
    3. a: Execute Run.bat
      b: Navigate to ./build/<Debug/Release>, and run try1.exe

  • Linux (tested on Linux Mint):
    Requires a pre-installed CMake, C++ compiler (ex. GCC), X11 (for SDL) and GLFW (for Box2D) toolkit. For ease of use, these are the commands used to retrieve those kits during the development of the project:

    • sudo apt-get install cmake
    • sudo apt-get install build-essential
    • sudo apt-get install libx11-dev
    • sudo apt-get install xorg-dev libglul-mesa-dev
    1. Choose a configuration - Debug or Release
    2. Run its corresponding shell script - GenerateAndBuild<Debug/Release>X64.sh, located in the root folder of the project
    3. a: Execute Run.sh
      b: Navigate to ./build/tr1, and run try1

Philosophy and how to contribute?

Project with modular architecture.
Every module in the project should be implemented with the intend that its libraries could change in the future.
This project adheres to the principle that every module should be initially implemented as an adapter, facade, template or a similar structural and creational patterns. This approach enables the internals of each module to evolve independently, while the code that utilizes each module remains unchanged.
Creational patterns are up to personal preference.
All libraries should be either vendored (and added as submodules) or fetched in a CMake configuration file