feat: add README

This commit is contained in:
Samsonium
2026-09-30 15:37:10 +03:00
parent a6676997d4
commit f01faf7351
2 changed files with 23 additions and 0 deletions
+1
View File
@@ -10,3 +10,4 @@
!/.gitignore
!/CMakeLists.txt
!/Makefile
!/README.md
+22
View File
@@ -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