From a256e8291a56043416af4ee164063f3605c480db Mon Sep 17 00:00:00 2001 From: Sean Sube Date: Mon, 17 Jun 2024 09:30:38 -0500 Subject: [PATCH] fix up readme features section --- README.md | 93 ++++++++++++++++++++++--------------------------------- 1 file changed, 37 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 5ce9115..271d566 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,49 @@ # TaleWeave AI -TaleWeave AI is an innovative open-source text adventure engine that harnesses the storytelling prowess and novel -behaviors of large language models to create a vibrant, interactive universe. This project merges the classic depth of -traditional text-based role-playing games with the cutting-edge capabilities of modern artificial intelligence, -delivering an immersive and versatile experience accessible via both Discord and web browsers. - -At the core of TaleWeave AI is the AI-powered dungeon master, which not only guides narratives but also populates the -world with dynamic AI characters. These characters interact within the game environment through advanced, extensible -function calls that allow for complex, evolving scenarios. Whether you are a game developer, storyteller, or enthusiast, -TaleWeave AI empowers you to craft unique worlds, tailor adventures to your liking, and script engaging scenarios that -captivate and engage players' imaginations. +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](https://docs-cdn.taleweave.ai/taleweave-github-1280.png) +## 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 step by step in notebook 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 - [TaleWeave AI](#taleweave-ai) - - [Contents](#contents) - [Features](#features) + - [Contents](#contents) - [Requirements](#requirements) - [Recommended](#recommended) - [Setup](#setup) @@ -26,51 +52,6 @@ captivate and engage players' imaginations. - [Support and Community](#support-and-community) - [License](#license) -## Features - -- **Cross-Platform Gameplay**: Enjoy a seamless gameplay experience across Discord and web browsers, ensuring - accessibility and continuous engagement no matter where you are. -- **Rich Interactions**: Dive into a world where AI-generated characters and real human players coexist, each bringing - unique elements to the narrative and gameplay. -- **Play as Any Character**: Every character in the world is always active, powered by large language models. Human - players can seamlessly take over AI characters, responding to system prompts and engaging in conversations with other - characters, enhancing the depth and flexibility of interactions. -- **AI-Driven World Generation**: Leverage the capabilities of a large language model acting as your dungeon master to - generate expansive, reactive worlds simply from a text prompt. -- **Enhanced Conversations**: Engage in deep, meaningful interactions with both AI and human characters, enriching your - gaming experience with every conversation and decision. -- **Customizable Actions**: Introduce your own actions to interact with the world and other characters in innovative - ways, adding a personal touch to every adventure. -- **Flexible Game Saving**: Easily save and resume your worlds at any time, preserving not only the state of the world - but also the language model's memory to maintain continuity in your adventures. -- **Dynamic Character Behavior**: Influence characters' behavior through logical systems that simulate hunger, mood, and - other life-like mechanics, adding layers of realism to your interactive experiences. - -Emergent behavior in TaleWeave AI offers a complex and captivating layer to gameplay, as large language models (LLMs) -interpret and act on character needs and feelings with surprising depth. By incorporating function-calling capabilities, -characters driven by these models can respond to prompts like "you are hungry" combined with an "eat" action by -logically determining the need to locate and consume food. Expanding these capabilities with additional systems such as -mood and stamina further enriches character interactions. For instance, a character who is both hungry and tired may -exhibit frustration or become argumentative, reflecting a nuanced behavioral response. These layered systems interact -dynamically, creating a web of possible actions and reactions that not only enhance the realism of the game world but -also lead to unique, unpredictable narratives formed by the characters' evolving conditions and decisions. - -As the AI-powered dungeon master, the large language model serves a pivotal role in TaleWeave AI, crafting not only the -overarching narratives but also the intricate details that bring the game world to life. This model excels in generating -descriptive, engaging flavor text that captures the essence of the world and its inhabitants, drawing on the same rich -data that fuels compelling storytelling in traditional text adventures. Whether it's adding intriguing twists when -characters use items or embedding subtle contextual clues into their interactions, the dungeon master ensures that each -element of the world is consistent and meaningful. By dynamically generating environments and scenarios, the dungeon -master model weaves together a coherent, immersive world where every character and their actions fit seamlessly into the -larger tapestry of the tale. - -In TaleWeave AI, the logic system employs a sophisticated combination of Python and YAML to construct intricate systems -that add and modify attributes on the rooms, characters, and items in the world. Each attribute is tagged with text -labels for both first-person prompts and third-person descriptions, enabling the system to directly influence the -behaviors and responses of the language models. This architecture allows for a dynamic interaction model where the -underlying logic subtly guides the actions and reactions of the AI, enriching the narrative depth and realism of the -game environment. - ## Requirements - Python 3.10