66 lines
2.0 KiB
Markdown
66 lines
2.0 KiB
Markdown
# SessionZero Client
|
|
|
|
An open-source TTRPG companion app for managing and playing tabletop role-playing games.
|
|
|
|
## About
|
|
|
|
SessionZero is a cross-platform desktop application built with Godot that helps players and GMs organize their TTRPG sessions. It's designed to be system-agnostic, supporting any tabletop RPG through modular data-driven systems.
|
|
|
|
### Key Features
|
|
|
|
- **System-Agnostic**: Works with any TTRPG system through data-driven systems
|
|
- **Full Offline Support**: Play completely offline with local data storage
|
|
- **Self-Hosted Multiplayer**: Host sessions directly from your machine with P2P networking or run a dedicated server
|
|
- **Open Content Format**: Import and create datapacks for characters, campaigns, items, and more
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Godot 4.6.x (for development)
|
|
- Windows or Linux (macOS support planned)
|
|
|
|
### Installation
|
|
|
|
**From Release:**
|
|
1. Download the latest release for your platform (if availible)
|
|
2. Extract and run the executable
|
|
|
|
**Optional:**
|
|
1. Purchase from a distribution platform or app store *`(Available upon 1.0 release)`*
|
|
|
|
**From Source:**
|
|
1. Clone this repository
|
|
2. Open the project in Godot 4.6.x
|
|
3. Run the project or export for your platform
|
|
|
|
## How It Works
|
|
|
|
## Development Roadmap
|
|
|
|
> WIP
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please read our [contributing guidelines](contribution-guidelines.md) before submitting pull requests.
|
|
|
|
## License
|
|
|
|
- **Application**: GPLv3 (GNU General Public License)
|
|
- **User Content (Datapacks, Templates, Modules, etc)**: Creative Commons BY-SA 4.0
|
|
|
|
## Support
|
|
|
|
For issues, feature requests, or questions:
|
|
- [Open an issue](https://git.bellsworne.tech/Bellsworne/sessionzero-resources/issues)
|
|
- Visit the website [SessionZero.app](https://sessionzero.app)
|
|
- Check the full [design document](design-doc.md)
|
|
- Join the [Matrix]() community
|
|
|
|
---
|
|
|
|
**Note**: SessionZero is in active development. Features may change as the project evolves.
|
|
|
|
---
|
|
|
|
**Made with `<3` by [Bellsworne Tech](https://bellsworne.com/tech)™** |