Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vtombesi/rs-gamebook-engine
A Rust implementation for json gamebooks
https://github.com/vtombesi/rs-gamebook-engine
gamebooks games rust
Last synced: 12 days ago
JSON representation
A Rust implementation for json gamebooks
- Host: GitHub
- URL: https://github.com/vtombesi/rs-gamebook-engine
- Owner: vtombesi
- License: mit
- Created: 2023-06-12T10:49:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-15T19:16:04.000Z (over 1 year ago)
- Last Synced: 2024-11-05T15:50:53.470Z (about 2 months ago)
- Topics: gamebooks, games, rust
- Language: Rust
- Homepage:
- Size: 66.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RS Gamebook Engine
[](LICENSE) [](https://github.com/vtombesi/rs-gamebook-engine/actions/workflows/rust.yml)
## Description
RS Gamebook Engine is a Rust library that allows you to create and play interactive text-based gamebooks. Inspired by the nostalgic gamebooks of the 80s, this engine provides a framework for building your own gamebooks with multiple branching paths, choices, combats, and loots.
## Features
- Create interactive gamebooks with multiple branching paths.
- Define pages with text, options, combats, and loots.
- Handle combats between the player and creatures with customizable attributes and attacks.
- Collect and manage items with different types, quantities, and effects.
- Save and load game progress.
## Installation
1. Install Rust and Cargo by following the instructions at [https://www.rust-lang.org/](https://www.rust-lang.org/).
2. Clone the RS Gamebook Engine repository:
```shell
git clone https://github.com/your-username/rs-gamebook-engine.git
```
## Usage
To use RS Gamebook Engine in your own project, add the following line to your `Cargo.toml` file:
```toml
[dependencies]
rs_gamebook_engine = "0.1.0"
```
Then, you can start using the library by importing the necessary modules:
```rust
use rs_gamebook_engine::gamebook::{Gamebook, Page};
use rs_gamebook_engine::player::Player;
use rs_gamebook_engine::utils::{load_gamebook, read_user_input};
fn main() {
// Load the gamebook from a JSON file
let gamebook = load_gamebook("path/to/gamebook.json");
// Create a new player
let mut player = Player::new();
// Start the game from the first page
let mut current_page_id = gamebook.start_page;
// Main game loop
loop {
// Find the current page
let current_page = gamebook.pages.iter().find(|p| p.id == current_page_id);
if let Some(page) = current_page.cloned() {
// Print the text of the current page
println!("{}", page.text);
// If there are no options, exit the loop
if page.options.is_empty() {
break;
}
// Print the available options
for (index, option) in page.options.iter().enumerate() {
println!("{}. {}", index + 1, option.text);
}
// Read user input
let user_input = read_user_input();
// Handle user input and update the current page
// ...
}
}
}
```
For a complete example of how to use RS Gamebook Engine, refer to the [examples](examples/examples.md) directory.
## License
RS Gamebook Engine is licensed under the [MIT License](LICENSE).
## Acknowledgements
RS Gamebook Engine is inspired by the gamebooks of the 80s and the joy they brought to many readers and adventurers.
## To Do
There are several enhancements and features that we are still working on to improve the gamebook experience. Here's what's on the horizon:
- **Conditional Options:** Developing a system to provide conditional game paths based on player's actions and choices.
- **Internationalization:** Implementing multiple languages to cater to our global user base.
- **Different Gamebook Examples:** Creating a diverse range of gamebook samples to showcase the flexibility and adaptability of our system.
- **Load Saved Games:** Adding the functionality for players to save their progress and resume their adventures at a later time.
- **Non-terminal UI:** Working on a user interface that isn't reliant on the terminal, for a more user-friendly and visually engaging experience.
- **Player Stats and Character Sheet:** Developing a comprehensive system for players to view and track their characters' progression and statistics.
Stay tuned for these exciting updates!
## Get in Touch
If you have any questions, suggestions, or just want to share your gamebook creations, feel free to reach out to us at [[email protected]](mailto:[email protected]).
Happy adventuring!