BartaEngine

BartaEngine

This is a c++ library which implements core features of a physics engine. The core concepts for now are:

• events handling system
• velocity calculation
• collision detection and collision responses

The project is open to collaboration at my GitHub account as there are plenty of ideas for new functionalities. This program is a base for my Master's degree research about soft bodies simulation.

Table of Contents

1. Installation
2. Development
3. Examples

---

Installation

Prerequisites

• C++20 Compiler: Ensure you have a compiler that supports C++20 (e.g., GCC 10+, Clang 10+, or MSVC 2019+).
• CMake: Required for building the project. Install the latest version from CMake.
• SFML 2.6.x: The project depends on SFML version 2.6.x.

Option 1: Use the library directly via FetchContent

• Add the following to your CMakeLists.txt file:

  include(FetchContent)
  
  FetchContent_Declare(
      BartaEngine
      GIT_REPOSITORY https://github.com/Bartanakin/BartaEngine.git
      GIT_TAG        main
  )
  
  FetchContent_MakeAvailable(BartaEngine)
  
  target_link_libraries(target PRIVATE BartaEngine)
  

Option 2: Use an existing template repository (recommended)

1. Clone the template repository

    git clone https://github.com/Bartanakin/BartaEngineSandbox.git
   

2. Proceed if you want to develop BartaEngine as well
3. Clone this repository

    git clone https://github.com/Bartanakin/BartaEngine.git

4. In BartaEngineSandbox in CMakeListst.txt in the root directory change FetchContent_Declare:

   FetchContent_Declare(
       BartaEngine
       SOURCE_DIR /local/path/to/BartaEngine
   )
   

Development

• To ensure your pull request passes the GitHub Actions checks, I recommend using clang-format 19 for code formatting. As for 20-11-2024 it is still unofficial version that you can download from here.
• All the current issues are at the Issues section.
• You can join the development community: write to me on Discord #Bartanakin or email me [email protected]

Examples

to be written down :)