https://github.com/Cultrarius/QuestWeaver
Procedurally generated quests and stories for computer games.
https://github.com/Cultrarius/QuestWeaver
computer-games entities game game-state procedural-generation quest quests stories
Last synced: about 1 year ago
JSON representation
Procedurally generated quests and stories for computer games.
- Host: GitHub
- URL: https://github.com/Cultrarius/QuestWeaver
- Owner: Cultrarius
- License: unlicense
- Created: 2015-08-10T18:00:44.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-12-12T19:39:31.000Z (over 8 years ago)
- Last Synced: 2024-11-10T22:39:57.693Z (over 1 year ago)
- Topics: computer-games, entities, game, game-state, procedural-generation, quest, quests, stories
- Language: C++
- Size: 8.8 MB
- Stars: 63
- Watchers: 10
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
# QuestWeaver
Procedurally generated quests and stories for computer games.
**This project is still in its early stages and under heavy development!**
## Features
* Fully **portable**, **serializable** quest system, perfect for use in savegames. Supports JSON and a compact binary format.
* Separates quest logic from quest data (such as titles/descriptions) by using **template files**.
* Can output the quest properties as simple **text or HTML form** to support rich formatting in the game.
* Uses a complex **weighted graph search** to create new quests.
This results in more interesting and coherent quest stories as world actors and entities can be reused when fitting.
* Supports **mod directories** to overwrite quest templates after deployment.
* The game world entities to be used in quests are supplied directly from a game's custom world model.
## Documentation
Have a look at the [API documentation](http://cultrarius.github.io/QuestWeaver/doxyhtml/)!
## Usage
The quest system of a game is not an isolated part of the system as it is heavily involved in the current world state and events.
Therefore, the game has to provide the quest system with the necessary information about the game's state and has to
fulfill change requests made by the quest system (otherwise the state will be inconsistent).
To use the QuestWeaver system, you have to follow these steps:
* Implement and register custom `TemplateFactory` classes that read your custom template files
* Implement a custom `WorldModel` class
* Register your wold model and template factories with the `QuestWeaver` instance
```cpp
QuestWeaver Init() {
// Create your template factories
unique_ptr questFactory = make_unique();
unique_ptr storyFactory = make_unique();
// Create Configuration
WeaverConfig config;
config.worldModel = make_unique();
config.dirs.modDirectory = "./Template/";
shared_ptr myWorldListener = make_shared();
// Create the quest system
QuestWeaver weaver(config);
weaver.RegisterQuestTemplateFactory(move(questFactory));
weaver.RegisterStoryTemplateFactory(move(storyFactory));
weaver.GetWorldModel().AddListener(myWorldListener);
return weaver;
}
// Create new quests
shared_ptr newQuest = weaver.CreateNewQuest();
```
Quests usually want to change the world state as well as their own state (e.g. when a quest succeeds).
To do that, you can tick the quest system in your game loop and it will take care of the rest by ticking each quest
separately.
The `WorldListener` allows you to change the game state whenever the world model was changed by the quest system.
```cpp
while (true) {
// game loop ...
weaver.Tick(delta); // updates the world state
}
```
You can also fully serialize the quest system, e.g. to create a save game or to debug it:
```cpp
void SerialTest() {
QuestWeaver weaver = Init();
// serialize
stringstream ss; // can also be a file stream
weaver.Serialize(ss, StreamType::JSON);
cout << ss.str() << endl; // or save it to disk
// deserialize - it is important to re-register the template factories and the world model listener!
QuestWeaver deserialized = QuestWeaver::Deserialize(ss, StreamType::JSON, config.dirs);
weaver.RegisterQuestTemplateFactory(move(questFactory));
weaver.RegisterStoryTemplateFactory(move(storyFactory));
weaver.GetWorldModel().AddListener(myWorldListener);
}
```
## Included projects
This project uses the help of some very fine frameworks:
* JSON parser: https://github.com/open-source-parsers/jsoncpp
* Serialization framework: http://uscilab.github.io/cereal/
* Testing framework: https://github.com/philsquared/Catch
* Name generation: https://github.com/skeeto/fantasyname