ComposeEngine

---

Copyrights

Andrea Catalini 2016-2023 Game Engine 2D - https://github.com/LaPeste/ComposeEngine

Zlib License:
This software is provided 'as-is', without any express or
implied warranty. In no event will the authors be held
liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute
it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented;
   you must not claim that you wrote the original software.
   If you use this software in a product, an acknowledgment
   in the product documentation would be appreciated but
   is not required.

2. Altered source versions must be plainly marked as such,
   and must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any
   source distribution.

Requirements

• Cmake 3.10 or higher
• SFML 2.x (http://sfml-dev.org)
• Minimal C++17 compiler support (tested with VS14, clang-800.0.38 and g++ 13.2.0)

Build and Run

I assume that you use Ninja, if not remember to add the -j NUMBER_OF_THREADS when compiling the project

1. From the root of the project go to the GameEngine folder:

   cd GameEngine

2. Fetch the submodules, which pulls sfml-tmxloader:

   git submodule update --init --recursive

3. Configure and build

   1. Prefer an out-of-source-build approach for the build
      1. create ./build/game and ./build/tmx-loader
      2. enter in each folder (first tmx-loader) and configure the build from each
      3. finally build each project (first the tmx loader)

      mkdir -p build/tmx-loader
      mkdir build/game
      cd build/tmx-loader
      cmake -G Ninja ../../sfml-tmxloader
      cd ../game
      cmake --build ../..

   2. Otherwise for an in-source-build:
      1. configure the build
      2. and compile the project

      cmake -G Ninja .
      cmake --build .
      
      # or if using make
      
      cmake --build . -j 8 # replace with the number of threads that you want

4. Run the executable from the GameEngine/ folder:

   bin/BUILD_TYPE/MarioClone

   For verbose builds, add -DVERBOSE=ON when configuring the build:

   cmake -G Ninja . -VERBOSE=ON
   cmake --build .

   When you want to turn the verbose off, reconfigure the build with -DVERBOSE=OFF and rebuild.