2024-05-09 03:57:11 +00:00
# TaleWeave AI
2024-05-09 03:26:01 +00:00
2024-06-17 14:30:38 +00:00
TaleWeave AI is an open-source game engine designed for creating rich, immersive text adventures and multi-user dungeons
(MUDs). Play through a Discord bot or a web browser for a versatile, cross-platform gaming experience.
2024-05-09 03:55:02 +00:00
2024-06-08 02:18:04 +00:00
![TaleWeave AI logo with glowing sunrise over angular castle ](https://docs-cdn.taleweave.ai/taleweave-github-1280.png )
2024-06-17 14:30:38 +00:00
## Features
2024-06-19 03:48:32 +00:00
TaleWeave AI is meant for gamers, developers, and researchers. It is a:
2024-06-17 14:30:38 +00:00
- multiplayer text adventure
- Discord role-playing game
- emergent behavior laboratory
- life simulator
- survival game
- game engine
- world generator
- human-machine interface
- multi-user dungeon
- cross-platform gaming experience
2024-06-19 03:48:32 +00:00
- behavioral experiment
2024-06-17 14:30:38 +00:00
TaleWeave AI does a few things out of the box:
- Generate a world from a brief text prompt
- Simulate the actions of characters in that world
- Allow humans to interact with each other and with NPCs
- Track detailed status for each entity: mood, hunger, thirst, hygiene, time of day, weather, etc
- Summarize the environment into LLM prompts
- Foster emergent behavior through action digests, shared environment, and note taking
TaleWeave AI can:
2024-06-19 03:48:32 +00:00
- Be modified in almost every way - everything is a plugin, including the planning and action stages that drive the simulation
2024-06-17 14:30:38 +00:00
- Be run locally - does not require any cloud services, but does play nicely with them
2024-06-19 03:48:32 +00:00
- Connect to your data - game systems can fetch data for RAG, making responses richer and more consistent
- Export training data - for analysis and fine tuning of character models
- Plug in to your workflow - run the simulation step by step in Jupyter notebooks using the TaleWeave AI engine as a Python library
2024-06-17 14:30:38 +00:00
- Connect to your server and vice versa - the Discord bot is a plugin and can be replaced with your favorite chat platform
2024-05-09 03:55:02 +00:00
## Contents
2024-05-09 03:57:11 +00:00
- [TaleWeave AI ](#taleweave-ai )
2024-05-09 03:55:02 +00:00
- [Features ](#features )
2024-06-17 14:30:38 +00:00
- [Contents ](#contents )
2024-06-04 02:37:22 +00:00
- [Requirements ](#requirements )
- [Recommended ](#recommended )
2024-06-04 02:39:57 +00:00
- [Setup ](#setup )
2024-05-09 03:55:02 +00:00
- [Documentation ](#documentation )
- [Contributing ](#contributing )
- [Support and Community ](#support-and-community )
- [License ](#license )
2024-05-09 03:26:01 +00:00
2024-06-04 02:37:22 +00:00
## Requirements
2024-05-09 03:26:01 +00:00
2024-06-04 02:37:22 +00:00
- Python 3.10
- Ollama, vLLM, or another OpenAI-compatible LLM API (including OpenAI)
2024-05-09 03:26:01 +00:00
2024-06-19 03:48:32 +00:00
While TaleWeave AI can be run entirely on CPU, one or more GPUs are highly recommended.
2024-06-04 02:37:22 +00:00
### Recommended
2024-05-09 03:26:01 +00:00
2024-06-04 02:37:22 +00:00
- 1-2 16GB or larger GPUs
- ComfyUI
- Discord account
2024-05-09 03:41:26 +00:00
2024-06-04 02:39:57 +00:00
## Setup
Please [see the admin guide for setup instructions ](./docs/guides/admin.md ).
TaleWeave AI is provided as both a Python module and a Docker container. [Everything can be run
locally](./docs/guides/admin.md#running-locally) or [run on a container host like
RunPod](./docs/guides/admin.md#running-on-runpod).
2024-05-09 03:26:01 +00:00
## Documentation
For a detailed guide on how to use TaleWeave AI, customize adventures, and integrate with Discord and web browsers,
2024-06-04 02:37:22 +00:00
please check out to [the documentation folder ](./docs ).
Detailed guides are available for:
- [admins ](./docs/guides/admin.md )
2024-06-17 14:33:09 +00:00
- [game developers ](./docs/guides/developer.md )
2024-06-04 03:08:58 +00:00
- [players ](./docs/guides/player.md )
2024-05-09 03:26:01 +00:00
## Contributing
2024-06-04 03:32:41 +00:00
TaleWeave AI is working, playable, and looking for contributors. We need developers to help improve the web client, add
new mechanics and systems to the game, and fine-tune models for better role playing.
2024-06-04 02:37:22 +00:00
[Check out the developer pitch for more details ](https://docs.google.com/presentation/d/1weHYaLzbRCq5A9K1iy33KdSvZ0bzCaBT6Trc0RCNJZE/edit?usp=sharing ).
2024-05-09 03:26:01 +00:00
## Support and Community
2024-05-09 03:55:02 +00:00
Join our community on Discord to discuss TaleWeave AI, share your experiences, and get help from fellow users and
2024-06-04 02:37:22 +00:00
developers.
[Click here to join the TaleWeave AI Discord Community ](https://discord.gg/4RfZBE77fa ).
2024-05-09 03:26:01 +00:00
## License
TaleWeave AI is released under the MIT License. See the [LICENSE ](./LICENSE ) file for more details.