diff --git a/.gitignore b/.gitignore index 0c6ec0e..d786d9b 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ !/.gitignore !/CMakeLists.txt !/Makefile +!/README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3761e3f --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# 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