RS Gamebook Engine

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

Install Rust and Cargo by following the instructions at https://www.rust-lang.org/.
Clone the RS Gamebook Engine repository:

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:

[dependencies]
rs_gamebook_engine = "0.1.0"

Then, you can start using the library by importing the necessary modules:

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 directory.

License

RS Gamebook Engine is licensed under the MIT 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 valentino.tombesi@gmail.com.

Happy adventuring!

vtombesi/rs-gamebook-engine