https://github.com/thurinum/gamebook
A fun little tool to create simple dialogue-based games.
https://github.com/thurinum/gamebook
dialogue-system gamebook qml qt qtquick xml
Last synced: about 2 months ago
JSON representation
A fun little tool to create simple dialogue-based games.
- Host: GitHub
- URL: https://github.com/thurinum/gamebook
- Owner: Thurinum
- License: gpl-3.0
- Created: 2022-06-08T18:45:10.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-28T01:21:22.000Z (over 2 years ago)
- Last Synced: 2025-01-27T14:50:42.339Z (4 months ago)
- Topics: dialogue-system, gamebook, qml, qt, qtquick, xml
- Language: QML
- Homepage:
- Size: 45.3 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Gamebook Studio
A fun little tool to create and play simple dialogue-tree based games.
## About
Gamebook Studio is a simple software for creating and parsing dialogue-tree based scenarios.
It's the result of a few months of work as a personal project. While still incomplete, it incorporate all the base features that make it usable.
### Licensing
This software is licensed under GNU GPLv3.
It's powered by the Qt framework, also under GPLv3.
### Running on Windows
Unzip the archive and run Gamebook.exe.
To access the dummy scenario, copy the Gamebook Studio Scenarios folder into your My Documents folder.
Config options are available inside gamebook.ini.
### Installing on Windows and Linux
- Install Qt 6.3 using the Online Installer.
- Open the project in Qt Creator.
- In the "Projects" tab, change the Run Configuration's Working Directory to %{ActiveProject:NativePath}
- Build and run, it should work fine (hopefully!).
## How it works
Scenarios hold *prompts*, which in turn contain *replies* that lead to other prompts.
### Prompts
Prompts represent the text spoken by a character to the player. They are identified by an UUID and:
- Contain HTML-formatted text;
- Are associated with a character;
- May define a background;
- May specify a music track to start playing;
- May define an accent colour;
- May directly lead to another prompt, with no replies;
- May end the story.
### Replies
Replies lead to other prompts. They:
- Have an HTML-formatted label;
- Have a target (UUID of a prompt).
## Features
In this alpha release, all essential features are available and ready for use. These include:
- Creating and editing scenarios;
- Playing existing scenarios;
- Saving user progress;
- Manually importing custom assets, such as character sprites, backgrounds, and music tracks;
- Editing prompts and replies, re-ordering replies;
- Creating and editing characters;
- Visualizing and filtering prompts in an outline view;
- Batch-editing prompts.