Sprouty Dialogs Documentation

Welcome to the official documentation repository for Sprouty Dialogs, a graph-based visual dialogue system plugin for the Godot Engine.

Note

This documentation is built using Docusaurus. To understand how the project is structured or how to customize it, refer to the Docusaurus documentation.

Installation

Prerequisites

• Node.js: Version 20.0 or higher.

• Package Manager: While npm works, Bun is recommended for this project. You can find the installation instructions here.

Setup

Follow these steps to get the project running locally:

1. Clone the repository:

git clone https://github.com/SproutyLabs/SproutyDialogsDocs.git

2. Navigate to the project directory:

cd SproutyDialogsDocs

3. Install dependencies:

bun i

4. Launch the documentation: You are now ready to run the site locally!

Local Development

Start the local development server with the following command:

bun start

This will launch the server and automatically open your browser to http://localhost:3000/SproutyDialogsDocs/. Most changes are reflected live without having to restart the server.

Project Structure

• /docs: Contains the Markdown files for the documentation. Add or edit content here.

• /static: Stores static assets such as images and multimedia.

• /src: Contains CSS styles, custom components, and the landing page.

For more information, please consult the Docusaurus documentation.