Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zegalur/libmozok-godot
This project demonstrates how LibMozok can be integrated with Godot.
https://github.com/zegalur/libmozok-godot
Last synced: about 1 month ago
JSON representation
This project demonstrates how LibMozok can be integrated with Godot.
- Host: GitHub
- URL: https://github.com/zegalur/libmozok-godot
- Owner: zegalur
- Created: 2024-05-31T14:53:38.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-08-19T10:01:01.000Z (4 months ago)
- Last Synced: 2024-08-19T11:53:58.883Z (4 months ago)
- Language: C++
- Size: 6.66 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LibMozok Godot DEMO
**LibMozok** is a universal quest engine for games. This library implements a system heavily inspired by ["Hierarchical generation of dynamic and nondeterministic quests in games"](https://www.researchgate.net/publication/286454232_Hierarchical_Generation_of_Dynamic_and_Nondeterministic_Quests_in_Games).
This demo illustrates how LibMozok can be integrated with Godot.
The game and its art style are inspired by the 2D Legend of Zelda games.
*Mozok, derived from the Ukrainian word "мозок" meaning "brain."*
# Showcase
LibMozok generates a plan for a quest in real-time and detects when the quest becomes unsolvable:
[YouTube](https://www.youtube.com/watch?v=g42drEw9XuY)
More...
The same quest, but successfully solved this time:
# How to Run the DEMO Project
## Prerequisites
1. C/C++ Compiler
2. CMake 3.22 or newer
3. SCons
4. Godot 4.3 or newer
5. git
## Installation
1. Create a working folder (this folder will be referred as `[WorkDir]`).
2. Download the **libmozok** [repository](https://github.com/zegalur/libmozok) into `[WorkDir]/libmozok`.
3. Download the **libmozok-godot** [repository](https://github.com/zegalur/libmozok-godot) into `[WorkDir]`.
4. Build and install **libmozok**:
1. Navigate to the build directory:
`cd [WorkDir]/libmozok/build`
2. Run CMake to configure the project:
`cmake ../src`
3. Build the project:
`cmake --build . --config Release`
4. Install the project:
`cmake --install . --config Release`
5. You should now have the non-empty `lib/` and `include/libmozok/` directories inside the `install` directory.
5. Build and install the `libmozok-godot` GDExtension:
1. Navigate to the repository:
`cd [WorkDir]/libmozok-godot`
2. (Initialize a Git repository if needed: `git init`)
3. (Add the Godot C++ bindings as a submodule if needed:
`git submodule add -b 4.3 https://github.com/godotengine/godot-cpp`)
4. Navigate to the Godot C++ bindings directory:
`cd godot-cpp`
5. Update and initialize the submodule:
`git submodule update --init`
6. Build the Godot C++ bindings:
`scons platform=` (**platform** is `windows`, `linux`, or `macos`)
7. Return to the **libmozok-godot** directory:
`cd ..`
8. Build the release version:
`scons platform= target=template_release`
9. Build the debug version:
`scons platform=`
10. You should now have the `libgdmozok` library files in `[WorkDir]/libmozok-godot/demo/bin`
11. Open the `gdmozok.gdextension` file in the `demo/bin` directory and ensure that the library file names match.
6. Open the DEMO project from `[WorkDir]/libmozok-godot/demo` in Godot.
7. If you encounter **"Load Errors"** messages, close the editor and reopen the project. Normally, there should be no errors after reloading the editor.
8. Run the DEMO.
# References
* Soares de Lima, Edirlei & Feijó, Bruno & Furtado, Antonio. (2014). *Hierarchical Generation of Dynamic and Nondeterministic Quests in Games.* ACM International Conference Proceeding Series. 2014. 10.1145/2663806.2663833. Web. https://www.researchgate.net/publication/286454232_Hierarchical_Generation_of_Dynamic_and_Nondeterministic_Quests_in_Games
# License
LibMozok is subject to the MIT license.
All other assets created for this demo are under CC0.
Created by Pavlo Savchuk, 2024.