Skip to content

Commit a256e82

Browse files
committed
fix up readme features section
1 parent 8a2af99 commit a256e82

File tree

1 file changed

+37
-56
lines changed

1 file changed

+37
-56
lines changed

README.md

+37-56
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,49 @@
11
# TaleWeave AI
22

3-
TaleWeave AI is an innovative open-source text adventure engine that harnesses the storytelling prowess and novel
4-
behaviors of large language models to create a vibrant, interactive universe. This project merges the classic depth of
5-
traditional text-based role-playing games with the cutting-edge capabilities of modern artificial intelligence,
6-
delivering an immersive and versatile experience accessible via both Discord and web browsers.
7-
8-
At the core of TaleWeave AI is the AI-powered dungeon master, which not only guides narratives but also populates the
9-
world with dynamic AI characters. These characters interact within the game environment through advanced, extensible
10-
function calls that allow for complex, evolving scenarios. Whether you are a game developer, storyteller, or enthusiast,
11-
TaleWeave AI empowers you to craft unique worlds, tailor adventures to your liking, and script engaging scenarios that
12-
captivate and engage players' imaginations.
3+
TaleWeave AI is an open-source game engine designed for creating rich, immersive text adventures and multi-user dungeons
4+
(MUDs). Play through a Discord bot or a web browser for a versatile, cross-platform gaming experience.
135

146
![TaleWeave AI logo with glowing sunrise over angular castle](https://docs-cdn.taleweave.ai/taleweave-github-1280.png)
157

8+
## Features
9+
10+
TaleWeave AI offers a range of features for gamers, developers, and researchers. It is a:
11+
12+
- multiplayer text adventure
13+
- Discord role-playing game
14+
- emergent behavior laboratory
15+
- life simulator
16+
- survival game
17+
- game engine
18+
- world generator
19+
- human-machine interface
20+
- multi-user dungeon
21+
- cross-platform gaming experience
22+
- behavior experiment
23+
24+
TaleWeave AI does a few things out of the box:
25+
26+
- Generate a world from a brief text prompt
27+
- Simulate the actions of characters in that world
28+
- Allow humans to interact with each other and with NPCs
29+
- Track detailed status for each entity: mood, hunger, thirst, hygiene, time of day, weather, etc
30+
- Summarize the environment into LLM prompts
31+
- Foster emergent behavior through action digests, shared environment, and note taking
32+
33+
TaleWeave AI can:
34+
35+
- Be modified in almost every way - everything is a plugin, including the planning-action loop that drives the simulation
36+
- Be run locally - does not require any cloud services, but does play nicely with them
37+
- Connect to your data - game systems can fetch data for RAG
38+
- Export training data for fine tuning character models
39+
- Plug in to your workflow - run step by step in notebook as a Python library
40+
- Connect to your server and vice versa - the Discord bot is a plugin and can be replaced with your favorite chat platform
41+
1642
## Contents
1743

1844
- [TaleWeave AI](#taleweave-ai)
19-
- [Contents](#contents)
2045
- [Features](#features)
46+
- [Contents](#contents)
2147
- [Requirements](#requirements)
2248
- [Recommended](#recommended)
2349
- [Setup](#setup)
@@ -26,51 +52,6 @@ captivate and engage players' imaginations.
2652
- [Support and Community](#support-and-community)
2753
- [License](#license)
2854

29-
## Features
30-
31-
- **Cross-Platform Gameplay**: Enjoy a seamless gameplay experience across Discord and web browsers, ensuring
32-
accessibility and continuous engagement no matter where you are.
33-
- **Rich Interactions**: Dive into a world where AI-generated characters and real human players coexist, each bringing
34-
unique elements to the narrative and gameplay.
35-
- **Play as Any Character**: Every character in the world is always active, powered by large language models. Human
36-
players can seamlessly take over AI characters, responding to system prompts and engaging in conversations with other
37-
characters, enhancing the depth and flexibility of interactions.
38-
- **AI-Driven World Generation**: Leverage the capabilities of a large language model acting as your dungeon master to
39-
generate expansive, reactive worlds simply from a text prompt.
40-
- **Enhanced Conversations**: Engage in deep, meaningful interactions with both AI and human characters, enriching your
41-
gaming experience with every conversation and decision.
42-
- **Customizable Actions**: Introduce your own actions to interact with the world and other characters in innovative
43-
ways, adding a personal touch to every adventure.
44-
- **Flexible Game Saving**: Easily save and resume your worlds at any time, preserving not only the state of the world
45-
but also the language model's memory to maintain continuity in your adventures.
46-
- **Dynamic Character Behavior**: Influence characters' behavior through logical systems that simulate hunger, mood, and
47-
other life-like mechanics, adding layers of realism to your interactive experiences.
48-
49-
Emergent behavior in TaleWeave AI offers a complex and captivating layer to gameplay, as large language models (LLMs)
50-
interpret and act on character needs and feelings with surprising depth. By incorporating function-calling capabilities,
51-
characters driven by these models can respond to prompts like "you are hungry" combined with an "eat" action by
52-
logically determining the need to locate and consume food. Expanding these capabilities with additional systems such as
53-
mood and stamina further enriches character interactions. For instance, a character who is both hungry and tired may
54-
exhibit frustration or become argumentative, reflecting a nuanced behavioral response. These layered systems interact
55-
dynamically, creating a web of possible actions and reactions that not only enhance the realism of the game world but
56-
also lead to unique, unpredictable narratives formed by the characters' evolving conditions and decisions.
57-
58-
As the AI-powered dungeon master, the large language model serves a pivotal role in TaleWeave AI, crafting not only the
59-
overarching narratives but also the intricate details that bring the game world to life. This model excels in generating
60-
descriptive, engaging flavor text that captures the essence of the world and its inhabitants, drawing on the same rich
61-
data that fuels compelling storytelling in traditional text adventures. Whether it's adding intriguing twists when
62-
characters use items or embedding subtle contextual clues into their interactions, the dungeon master ensures that each
63-
element of the world is consistent and meaningful. By dynamically generating environments and scenarios, the dungeon
64-
master model weaves together a coherent, immersive world where every character and their actions fit seamlessly into the
65-
larger tapestry of the tale.
66-
67-
In TaleWeave AI, the logic system employs a sophisticated combination of Python and YAML to construct intricate systems
68-
that add and modify attributes on the rooms, characters, and items in the world. Each attribute is tagged with text
69-
labels for both first-person prompts and third-person descriptions, enabling the system to directly influence the
70-
behaviors and responses of the language models. This architecture allows for a dynamic interaction model where the
71-
underlying logic subtly guides the actions and reactions of the AI, enriching the narrative depth and realism of the
72-
game environment.
73-
7455
## Requirements
7556

7657
- Python 3.10

0 commit comments

Comments
 (0)