5 Commits
Author SHA1 Message Date
Samsonium 1a2722da57 fix: compilation errors 2026-10-03 14:59:43 +03:00
Samsonium 12deed7aee feat: implement module lifecycle 2026-10-03 14:57:12 +03:00
Samsonium 33941a823c ref: remove test module header file 2026-10-03 14:27:33 +03:00
Samsonium ca7db648f8 feat: add clang format file (i hate google style) 2026-10-03 14:27:06 +03:00
Samsonium 7a158a0bf8 feat: update engine features
- WIP start/stop methods
- Remove test module
2026-10-01 14:55:42 +03:00
11 changed files with 220 additions and 191 deletions
+3
View File
@@ -0,0 +1,3 @@
BasedOnStyle: LLVM
IndentWidth: 2
BreakBeforeBraces: Allman
+1 -2
View File
@@ -5,10 +5,9 @@
!/include !/include
!/src !/src
!/tests !/tests
!/utils
# Include files # Include files
!/.clang-format
!/.gitignore !/.gitignore
!/CMakeLists.txt !/CMakeLists.txt
!/Makefile !/Makefile
!/README.md
+1 -7
View File
@@ -4,8 +4,6 @@ project(magic_scrolls)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON) set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
find_package(SQLite3 REQUIRED) find_package(SQLite3 REQUIRED)
find_package(oatpp 1.4.0 REQUIRED)
find_package(oatpp-swagger 1.4.0 REQUIRED)
file(GLOB_RECURSE sources file(GLOB_RECURSE sources
"${CMAKE_SOURCE_DIR}/src/*.cpp") "${CMAKE_SOURCE_DIR}/src/*.cpp")
@@ -13,11 +11,7 @@ file(GLOB_RECURSE sources
add_executable(magic_scrolls ${sources}) add_executable(magic_scrolls ${sources})
target_include_directories(magic_scrolls PUBLIC "${CMAKE_SOURCE_DIR}/include") target_include_directories(magic_scrolls PUBLIC "${CMAKE_SOURCE_DIR}/include")
target_link_libraries(magic_scrolls PRIVATE target_link_libraries(magic_scrolls PRIVATE SQLite::SQLite3)
SQLite::SQLite3
oatpp::oatpp
oatpp::oatpp-swagger
)
# ------- # -------
enable_testing() enable_testing()
-22
View File
@@ -1,22 +0,0 @@
# Magic Scrolls
Server-side game engine for the game "Magic Scrolls".
This engine is building as:
- **Core**: provides event bus, database providers factory, module registration, lifecycle events
- **Modules**: separate parts that can use core features using engine public API
## Requirements
- **Make**: 4.4.1
- **CMake**: 4.2.3
- **GCC**: 15.2.0
- **sqlite3-dev** (lib): 3.46.1
## How to run
1. Clone repository
2. Run `sudo ./utils/install-oatpp.sh`
3. Build: `cmake -B build` and then `cmake --build build`
4. Run: `./build/magic_scrolls
+21 -5
View File
@@ -1,10 +1,10 @@
#ifndef __MCS_ENGINE_HPP__ #ifndef __MCS_ENGINE_HPP__
#define __MCS_ENGINE_HPP__ #define __MCS_ENGINE_HPP__
#include <cstdint>
#include <engine/core/engine_db_provider.hpp>
#include <engine/core/engine_module.hpp> #include <engine/core/engine_module.hpp>
#include <engine/core/engine_module_api.hpp> #include <engine/core/engine_module_api.hpp>
#include <engine/core/engine_db_provider.hpp>
#include <cstdint>
#include <memory> #include <memory>
#include <vector> #include <vector>
@@ -12,21 +12,37 @@
class MscEngine : public IMscEngineModuleAPI class MscEngine : public IMscEngineModuleAPI
{ {
private: private:
/// Loaded modules list /// @brief Loaded modules list
std::vector<std::shared_ptr<MscEngineModule>> _modules; std::vector<std::shared_ptr<MscEngineModule>> _modules;
/// @brief Common event bus
MscEventBus _bus; MscEventBus _bus;
/// @brief Is engine running rn
bool _isRunning = false;
/// @brief Last update time
clock::time_point _lastUpdate;
public: public:
/// Actual version /// Actual version
static uint16_t REV; static uint16_t REV;
MscEngine(std::vector<std::shared_ptr<MscEngineModule>> modules); MscEngine(std::vector<std::shared_ptr<MscEngineModule>> modules);
/// @brief Start engine
void start();
/// @brief Stop engine
void stop();
MscEventBus &getBus() override; MscEventBus &getBus() override;
std::unordered_map<std::string, std::uint16_t> getLoadedModules() const override; std::unordered_map<std::string, std::uint16_t>
getLoadedModules() const override;
MscEngineModule &getModule(const std::string &name) override; MscEngineModule &getModule(const std::string &name) override;
std::unique_ptr<MscEngineDBProvider> createDBProvider() override; std::unique_ptr<MscEngineDBProvider> createDBProvider() override;
std::unique_ptr<MscEngineDBProvider> createDBProvider(const std::string &filepath) override; std::unique_ptr<MscEngineDBProvider>
createDBProvider(const std::string &filepath) override;
}; };
#endif // __MCS_ENGINE_HPP__ #endif // __MCS_ENGINE_HPP__
+21 -2
View File
@@ -1,8 +1,8 @@
#ifndef __MCS_ENGINE_MODULE_HPP__ #ifndef __MCS_ENGINE_MODULE_HPP__
#define __MCS_ENGINE_MODULE_HPP__ #define __MCS_ENGINE_MODULE_HPP__
#include "engine/utils/rev_range.hpp"
#include "engine/core/engine_module_api.hpp" #include "engine/core/engine_module_api.hpp"
#include "engine/utils/rev_range.hpp"
#include <cstdint> #include <cstdint>
#include <string> #include <string>
#include <unordered_map> #include <unordered_map>
@@ -23,8 +23,27 @@ public:
virtual const std::unordered_map<std::string, MscRevisionRange> & virtual const std::unordered_map<std::string, MscRevisionRange> &
getDependencies() const = 0; getDependencies() const = 0;
/// Module initialization phase /// @brief Module initialization
/// @param engine engine public API for modules
virtual void onInitialize(IMscEngineModuleAPI &engine) = 0; virtual void onInitialize(IMscEngineModuleAPI &engine) = 0;
/// @brief Engine start event handler
/// @param engine engine public API for modules
virtual void onStart(IMscEngineModuleAPI &engine) = 0;
/// @brief Engine update cycle step
/// @param engine engine public API for modules
/// @param dt loop delta
virtual void onUpdate(IMscEngineModuleAPI &engine,
IMscEngineModuleAPI::clock::duration dt) = 0;
/// @brief Engine stop event handler
/// @param engine engine public API for modules
virtual void onStop(IMscEngineModuleAPI &engine) = 0;
/// @brief Module destroying
/// @param engine engine public API for modules
virtual void onDestory(IMscEngineModuleAPI &engine) = 0;
}; };
#endif // __MCS_ENGINE_MODULE_HPP__ #endif // __MCS_ENGINE_MODULE_HPP__
+8 -4
View File
@@ -1,25 +1,28 @@
#ifndef __MSC_ENGINE_MODULE_API_HPP__ #ifndef __MSC_ENGINE_MODULE_API_HPP__
#define __MSC_ENGINE_MODULE_API_HPP__ #define __MSC_ENGINE_MODULE_API_HPP__
#include <cstdint>
#include <engine/core/engine_bus.hpp> #include <engine/core/engine_bus.hpp>
#include <engine/core/engine_db_provider.hpp> #include <engine/core/engine_db_provider.hpp>
#include <cstdint> #include <memory>
#include <string> #include <string>
#include <unordered_map> #include <unordered_map>
#include <memory>
class MscEngineModule; class MscEngineModule;
class IMscEngineModuleAPI class IMscEngineModuleAPI
{ {
public: public:
using clock = std::chrono::steady_clock;
virtual ~IMscEngineModuleAPI() = default; virtual ~IMscEngineModuleAPI() = default;
/// @brief Get access to engine event bus /// @brief Get access to engine event bus
virtual MscEventBus &getBus() = 0; virtual MscEventBus &getBus() = 0;
/// @brief Get access to loaded module list /// @brief Get access to loaded module list
virtual std::unordered_map<std::string, std::uint16_t> getLoadedModules() const = 0; virtual std::unordered_map<std::string, std::uint16_t>
getLoadedModules() const = 0;
/// @brief Access module by its name /// @brief Access module by its name
virtual MscEngineModule &getModule(const std::string &name) = 0; virtual MscEngineModule &getModule(const std::string &name) = 0;
@@ -28,7 +31,8 @@ public:
virtual std::unique_ptr<MscEngineDBProvider> createDBProvider() = 0; virtual std::unique_ptr<MscEngineDBProvider> createDBProvider() = 0;
/// @brief Create database provider with file database /// @brief Create database provider with file database
virtual std::unique_ptr<MscEngineDBProvider> createDBProvider(const std::string &filepath) = 0; virtual std::unique_ptr<MscEngineDBProvider>
createDBProvider(const std::string &filepath) = 0;
}; };
#endif // __MSC_ENGINE_MODULE_API_HPP__ #endif // __MSC_ENGINE_MODULE_API_HPP__
+64 -5
View File
@@ -1,12 +1,16 @@
#include "engine/core/engine_module_api.hpp"
#include <chrono>
#include <cstdint> #include <cstdint>
#include <engine/core/engine.hpp> #include <engine/core/engine.hpp>
#include <functional>
#include <memory> #include <memory>
#include <stdexcept> #include <stdexcept>
#include <string> #include <string>
#include <thread>
#include <unordered_map> #include <unordered_map>
#include <vector> #include <vector>
uint16_t MscEngine::REV = 0; std::uint16_t MscEngine::REV = 1;
MscEngine::MscEngine(std::vector<std::shared_ptr<MscEngineModule>> modules) MscEngine::MscEngine(std::vector<std::shared_ptr<MscEngineModule>> modules)
{ {
@@ -49,17 +53,71 @@ MscEngine::MscEngine(std::vector<std::shared_ptr<MscEngineModule>> modules)
std::to_string(current_rev)); std::to_string(current_rev));
} }
} }
module.get()->onInitialize(*this);
} }
_modules = std::move(modules); _modules = std::move(modules);
} }
MscEventBus &MscEngine::getBus() void MscEngine::start()
{ {
return _bus; if (_isRunning)
return;
_isRunning = true;
_lastUpdate = clock::now();
for (auto &m : _modules)
m->onStart(*this);
constexpr auto tickDuration = std::chrono::milliseconds(50);
auto nextTick = clock::now();
using UpdateFn = std::function<void(IMscEngineModuleAPI & engine,
IMscEngineModuleAPI::clock::duration dt)>;
std::vector<UpdateFn> updateFns;
updateFns.reserve(_modules.size());
for (auto &m : _modules)
updateFns.emplace_back([m](IMscEngineModuleAPI &engine,
IMscEngineModuleAPI::clock::duration dt)
{ m->onUpdate(engine, dt); });
while (_isRunning)
{
nextTick += tickDuration;
const auto currentTick = clock::now();
const auto dt = currentTick - _lastUpdate;
// TODO: process
for (auto upd : updateFns)
upd(*this, dt);
_lastUpdate = currentTick;
std::this_thread::sleep_until(nextTick);
if (clock::now() > nextTick + std::chrono::seconds(1))
nextTick = clock::now();
} }
std::unordered_map<std::string, std::uint16_t> MscEngine::getLoadedModules() const for (auto &m : _modules)
m->onStop(*this);
}
void MscEngine::stop()
{
if (!_isRunning)
return;
_isRunning = false;
}
MscEventBus &MscEngine::getBus() { return _bus; }
std::unordered_map<std::string, std::uint16_t>
MscEngine::getLoadedModules() const
{ {
std::unordered_map<std::string, std::uint16_t> result; std::unordered_map<std::string, std::uint16_t> result;
for (const auto &module : _modules) for (const auto &module : _modules)
@@ -90,7 +148,8 @@ std::unique_ptr<MscEngineDBProvider> MscEngine::createDBProvider()
return std::make_unique<MscEngineDBProvider>(); return std::make_unique<MscEngineDBProvider>();
} }
std::unique_ptr<MscEngineDBProvider> MscEngine::createDBProvider(const std::string &filepath) std::unique_ptr<MscEngineDBProvider>
MscEngine::createDBProvider(const std::string &filepath)
{ {
return std::make_unique<MscEngineDBProvider>(filepath); return std::make_unique<MscEngineDBProvider>(filepath);
} }
+1 -8
View File
@@ -1,16 +1,9 @@
#include "engine/modules/test1/test1.hpp"
#include <cstdio> #include <cstdio>
#include <engine/core/engine.hpp> #include <engine/core/engine.hpp>
#include <memory>
#include <stdlib.h> #include <stdlib.h>
#include <vector>
int main(int argc, char **argv) int main(int argc, char **argv)
{ {
auto engine = printf("Hello, engine!\n");
std::make_unique<MscEngine>(std::vector<std::shared_ptr<MscEngineModule>>{
std::make_shared<Test1Module>()});
printf("Hello, CMake, %p!\n", &engine);
return 0; return 0;
} }
+49 -41
View File
@@ -1,71 +1,70 @@
#include <cassert> #include <cassert>
#include <string>
#include <cstdint> #include <cstdint>
#include <memory>
#include <stdexcept>
#include <unordered_map>
#include <engine/utils/rev_range.hpp>
#include <engine/core/engine.hpp> #include <engine/core/engine.hpp>
#include <engine/core/engine_module.hpp> #include <engine/core/engine_module.hpp>
#include <engine/utils/rev_range.hpp>
#include <memory>
#include <stdexcept>
#include <string>
#include <unordered_map>
class FirstTestModuleR1 : public MscEngineModule class FirstTestModuleR1 : public MscEngineModule
{ {
public: public:
std::string getName() const override std::string getName() const override { return "first_tmod"; };
{
return "first_tmod";
};
std::uint16_t getRev() const override std::uint16_t getRev() const override { return 1; }
{
return 1;
}
const std::unordered_map<std::string, MscRevisionRange> &getDependencies() const override const std::unordered_map<std::string, MscRevisionRange> &
getDependencies() const override
{ {
static const std::unordered_map<std::string, MscRevisionRange> deps{}; static const std::unordered_map<std::string, MscRevisionRange> deps{};
return deps; return deps;
} }
void onInitialize(IMscEngineModuleAPI &engine) override {} void onInitialize(IMscEngineModuleAPI &engine) override {}
void onStart(IMscEngineModuleAPI &engine) override {}
void onUpdate(IMscEngineModuleAPI &engine,
IMscEngineModuleAPI::clock::duration dt) override
{
}
void onStop(IMscEngineModuleAPI &engine) override {}
void onDestory(IMscEngineModuleAPI &engine) override {}
}; };
class FirstTestModuleR2 : public MscEngineModule class FirstTestModuleR2 : public MscEngineModule
{ {
public: public:
std::string getName() const override std::string getName() const override { return "first_tmod"; };
{
return "first_tmod";
};
std::uint16_t getRev() const override std::uint16_t getRev() const override { return 2; }
{
return 2;
}
const std::unordered_map<std::string, MscRevisionRange> &getDependencies() const override const std::unordered_map<std::string, MscRevisionRange> &
getDependencies() const override
{ {
static const std::unordered_map<std::string, MscRevisionRange> deps{}; static const std::unordered_map<std::string, MscRevisionRange> deps{};
return deps; return deps;
} }
void onInitialize(IMscEngineModuleAPI &engine) override {} void onInitialize(IMscEngineModuleAPI &engine) override {}
void onStart(IMscEngineModuleAPI &engine) override {}
void onUpdate(IMscEngineModuleAPI &engine,
IMscEngineModuleAPI::clock::duration dt) override
{
}
void onStop(IMscEngineModuleAPI &engine) override {}
void onDestory(IMscEngineModuleAPI &engine) override {}
}; };
class SecondTestModuleE1 : public MscEngineModule class SecondTestModuleE1 : public MscEngineModule
{ {
public: public:
std::string getName() const override std::string getName() const override { return "second_tmod"; }
{
return "second_tmod";
}
std::uint16_t getRev() const override std::uint16_t getRev() const override { return 1; }
{
return 1;
}
const std::unordered_map<std::string, MscRevisionRange> &getDependencies() const override const std::unordered_map<std::string, MscRevisionRange> &
getDependencies() const override
{ {
static const std::unordered_map<std::string, MscRevisionRange> deps{ static const std::unordered_map<std::string, MscRevisionRange> deps{
{"first_tmod", MscRevisionRange{1, 1}}}; {"first_tmod", MscRevisionRange{1, 1}}};
@@ -73,22 +72,24 @@ public:
} }
void onInitialize(IMscEngineModuleAPI &engine) override {} void onInitialize(IMscEngineModuleAPI &engine) override {}
void onStart(IMscEngineModuleAPI &engine) override {}
void onUpdate(IMscEngineModuleAPI &engine,
IMscEngineModuleAPI::clock::duration dt) override
{
}
void onStop(IMscEngineModuleAPI &engine) override {}
void onDestory(IMscEngineModuleAPI &engine) override {}
}; };
class SecondTestModuleE2 : public MscEngineModule class SecondTestModuleE2 : public MscEngineModule
{ {
public: public:
std::string getName() const override std::string getName() const override { return "second_tmod"; }
{
return "second_tmod";
}
std::uint16_t getRev() const override std::uint16_t getRev() const override { return 1; }
{
return 1;
}
const std::unordered_map<std::string, MscRevisionRange> &getDependencies() const override const std::unordered_map<std::string, MscRevisionRange> &
getDependencies() const override
{ {
static const std::unordered_map<std::string, MscRevisionRange> deps{ static const std::unordered_map<std::string, MscRevisionRange> deps{
{"first_tmod", MscRevisionRange{1, 2}}}; {"first_tmod", MscRevisionRange{1, 2}}};
@@ -96,6 +97,13 @@ public:
} }
void onInitialize(IMscEngineModuleAPI &engine) override {} void onInitialize(IMscEngineModuleAPI &engine) override {}
void onStart(IMscEngineModuleAPI &engine) override {}
void onUpdate(IMscEngineModuleAPI &engine,
IMscEngineModuleAPI::clock::duration dt) override
{
}
void onStop(IMscEngineModuleAPI &engine) override {}
void onDestory(IMscEngineModuleAPI &engine) override {}
}; };
void testSatisfiedModules() void testSatisfiedModules()
-44
View File
@@ -1,44 +0,0 @@
#!/bin/bash
BUILD_TYPE=$1
if [ -z "$BUILD_TYPE" ]; then
BUILD_TYPE="Debug"
fi
rm -rf tmp
mkdir tmp
cd tmp
function install_module () {
BUILD_TYPE=$1
MODULE_NAME=$2
NPROC=$(nproc)
if [ -z "$NPROC" ]; then
NPROC=1
fi
echo "-> [ ] Installing '$MODULE_NAME' ($BUILD_TYPE)..."
git clone --depth=1 https://github.com/oatpp/$MODULE_NAME
cd $MODULE_NAME
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DOATPP_BUILD_TESTS=OFF -DOATPP_SQLITE_AMALGAMATION=ON ..
make install -j $NPROC
cd ../..
echo "-> [x] Module '$MODULE_NAME' installed!"
}
install_module $BUILD_TYPE oatpp
install_module $BUILD_TYPE oatpp-swagger
cd ..
rm -rf tmp