1
0
Fork 0
Go to file
Sean Sube 7eb81ea41c
Run Docker Build / build (push) Successful in 13s Details
Run Python Build / build (push) Successful in 26s Details
link dev guide in readme
2024-06-17 09:33:09 -05:00
.github/workflows use branch tags for container 2024-06-01 04:45:38 -05:00
.vscode fix logging, make config optional, fix event attributes 2024-05-18 16:20:47 -05:00
client SSL support for websocket server, basic world editor, various prompt fixes 2024-06-10 19:27:43 -05:00
docs start dev guide 2024-06-17 09:32:25 -05:00
prompts make system format return a list of labels 2024-06-16 16:36:24 -05:00
requirements install packit from github 2024-05-27 18:21:01 -05:00
schemas add schema tool, add new world command to editor 2024-06-16 21:06:35 -05:00
site add logo to readme, add home page 2024-06-07 21:18:04 -05:00
taleweave start dev guide 2024-06-17 09:32:25 -05:00
tests make sure config is used consistently, start adding tests 2024-06-01 14:46:11 -05:00
.dockerignore add container and missing deps 2024-05-19 14:17:09 -05:00
.gitignore make sure config is used consistently, start adding tests 2024-06-01 14:46:11 -05:00
Dockerfile add missing files to container 2024-06-01 04:52:14 -05:00
LICENSE.md add license 2024-05-12 13:14:27 -05:00
Makefile split up simulation into planning and action systems 2024-06-12 23:02:25 -05:00
README.md link dev guide in readme 2024-06-17 09:33:09 -05:00
config.yml add missing fields to config, use config memory limit 2024-06-02 20:14:41 -05:00
example.env add example env 2024-05-08 22:55:02 -05:00
logging.json add client app 2024-05-04 15:36:55 -05:00
pyproject.toml first version 2024-05-02 06:25:35 -05:00
setup.cfg split up sections 2024-05-02 06:56:57 -05:00
tsconfig.json add client app 2024-05-04 15:36:55 -05:00
worlds.yml split up simulation into planning and action systems 2024-06-12 23:02:25 -05:00

README.md

TaleWeave AI

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.

TaleWeave AI logo with glowing sunrise over angular castle

Features

TaleWeave AI offers a range of features for gamers, developers, and researchers. It is a:

  • 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
  • behavior experiment

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:

  • Be modified in almost every way - everything is a plugin, including the planning-action loop that drives the simulation
  • Be run locally - does not require any cloud services, but does play nicely with them
  • Connect to your data - game systems can fetch data for RAG
  • Export training data for fine tuning character models
  • Plug in to your workflow - run the simulation step by step in Jupyter notebooks as a Python library
  • Connect to your server and vice versa - the Discord bot is a plugin and can be replaced with your favorite chat platform

Contents

Requirements

  • Python 3.10
  • Ollama, vLLM, or another OpenAI-compatible LLM API (including OpenAI)
  • 1-2 16GB or larger GPUs
  • ComfyUI
  • Discord account

Setup

Please see the admin guide for setup instructions.

TaleWeave AI is provided as both a Python module and a Docker container. Everything can be run locally or run on a container host like RunPod.

Documentation

For a detailed guide on how to use TaleWeave AI, customize adventures, and integrate with Discord and web browsers, please check out to the documentation folder.

Detailed guides are available for:

Contributing

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.

Check out the developer pitch for more details.

Support and Community

Join our community on Discord to discuss TaleWeave AI, share your experiences, and get help from fellow users and developers.

Click here to join the TaleWeave AI Discord Community.

License

TaleWeave AI is released under the MIT License. See the LICENSE file for more details.