add checklist to admin guide, remove setup instructions from readme
This commit is contained in:
parent
1e6c5df462
commit
5458bf8397
GPG Key ID:
3EED7B957D362AF1
89
README.md
89
README.md
|
|
@ -16,12 +16,8 @@ captivate and engage players' imaginations.
|
||||||
- [TaleWeave AI](#taleweave-ai)
|
- [TaleWeave AI](#taleweave-ai)
|
||||||
- [Contents](#contents)
|
- [Contents](#contents)
|
||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
- [Installation](#installation)
|
- [Requirements](#requirements)
|
||||||
- [Step 1: Clone the Repository](#step-1-clone-the-repository)
|
- [Recommended](#recommended)
|
||||||
- [Step 2: Set Up Your Environment](#step-2-set-up-your-environment)
|
|
||||||
- [Step 3: Configuration](#step-3-configuration)
|
|
||||||
- [Step 4: Run the Dependencies](#step-4-run-the-dependencies)
|
|
||||||
- [Step 5: Launch the Game Server](#step-5-launch-the-game-server)
|
|
||||||
- [Documentation](#documentation)
|
- [Documentation](#documentation)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [Support and Community](#support-and-community)
|
- [Support and Community](#support-and-community)
|
||||||
|
|
@ -72,82 +68,39 @@ behaviors and responses of the language models. This architecture allows for a d
|
||||||
underlying logic subtly guides the actions and reactions of the AI, enriching the narrative depth and realism of the
|
underlying logic subtly guides the actions and reactions of the AI, enriching the narrative depth and realism of the
|
||||||
game environment.
|
game environment.
|
||||||
|
|
||||||
## Installation
|
## Requirements
|
||||||
|
|
||||||
### Step 1: Clone the Repository
|
- Python 3.10
|
||||||
|
- Ollama, vLLM, or another OpenAI-compatible LLM API (including OpenAI)
|
||||||
|
|
||||||
```bash
|
### Recommended
|
||||||
git clone https://github.com/ssube/taleweave-ai.git
|
|
||||||
cd taleweave-ai
|
|
||||||
```
|
|
||||||
|
|
||||||
### Step 2: Set Up Your Environment
|
- 1-2 16GB or larger GPUs
|
||||||
|
- ComfyUI
|
||||||
```bash
|
- Discord account
|
||||||
# Create a virtual environment
|
|
||||||
python3 -m venv venv
|
|
||||||
# Load the virtual environment
|
|
||||||
source venv/bin/activate
|
|
||||||
# Install dependencies
|
|
||||||
pip install -r requirements.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
### Step 3: Configuration
|
|
||||||
|
|
||||||
Configure the settings by editing the `.env` file to match your setup, including Discord tokens and web server details.
|
|
||||||
|
|
||||||
### Step 4: Run the Dependencies
|
|
||||||
|
|
||||||
Launch Comfy UI for image generation and Ollama for text generation.
|
|
||||||
|
|
||||||
### Step 5: Launch the Game Server
|
|
||||||
|
|
||||||
To start a game simulation using the "outback animals" example prompt and running both the Discord both and websocket
|
|
||||||
server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Start the TaleWeave AI engine
|
|
||||||
python3 -m taleweave.main \
|
|
||||||
--world worlds/outback-animals-1 \
|
|
||||||
--world-prompt ./taleweave/prompts.yml:outback-animals \
|
|
||||||
--discord=true \
|
|
||||||
--server=true \
|
|
||||||
--rooms 3 \
|
|
||||||
--turns 30 \
|
|
||||||
--optional-actions=true \
|
|
||||||
--actions taleweave.systems.sim:init_actions \
|
|
||||||
--systems taleweave.systems.sim:init_logic
|
|
||||||
```
|
|
||||||
|
|
||||||
This will generate a relatively small world with 3 rooms or areas, run for 30 steps, then shut down.
|
|
||||||
|
|
||||||
The world will be saved to a file named `worlds/outback-animals-1.json` and the state will be saved after each step to
|
|
||||||
another file named `worlds/outback-animals-1.state.json`. The world can be stopped at any time by pressing Ctrl-C,
|
|
||||||
although the step in progress will be lost. The saved state can be resumed and played for any number of additional
|
|
||||||
steps by running the server again with the same arguments.
|
|
||||||
|
|
||||||
> Note: `module.name:function_name` and `path/filename.yml:key` are patterns you will see repeated throughout TaleWeave AI.
|
|
||||||
> They indicate a Python module and function within it, or a data file and key within it, respectively.
|
|
||||||
|
|
||||||
The `sim_systems` provide many mechanics from popular life simulations, including hunger, thirst, exhaustion, and mood.
|
|
||||||
Custom actions and systems can be used to provide any other mechanics that are desired for your setting. The logic
|
|
||||||
system uses a combination of Python and YAML to modify the prompts connected to rooms, characters, and items in the
|
|
||||||
world, influencing the behavior of the language models.
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
For a detailed guide on how to use TaleWeave AI, customize adventures, and integrate with Discord and web browsers,
|
For a detailed guide on how to use TaleWeave AI, customize adventures, and integrate with Discord and web browsers,
|
||||||
please refer to our [Documentation](./docs). This guide includes comprehensive instructions on:
|
please check out to [the documentation folder](./docs).
|
||||||
|
|
||||||
|
Detailed guides are available for:
|
||||||
|
|
||||||
|
- [admins](./docs/guides/admin.md)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
TaleWeave AI is a community-driven project, and we welcome contributions of all kinds. If you're interested in improving
|
TaleWeave AI is working and playable, and looking for contributors to help improve the web client, add new mechanics
|
||||||
the engine or adding new features, please check out our contributing guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md).
|
and systems to the game, and fine-tune models for better role playing.
|
||||||
|
|
||||||
|
[Check out the developer pitch for more details](https://docs.google.com/presentation/d/1weHYaLzbRCq5A9K1iy33KdSvZ0bzCaBT6Trc0RCNJZE/edit?usp=sharing).
|
||||||
|
|
||||||
## Support and Community
|
## Support and Community
|
||||||
|
|
||||||
Join our community on Discord to discuss TaleWeave AI, share your experiences, and get help from fellow users and
|
Join our community on Discord to discuss TaleWeave AI, share your experiences, and get help from fellow users and
|
||||||
developers. Click here to join: [TaleWeave AI Discord Community](#)
|
developers.
|
||||||
|
|
||||||
|
[Click here to join the TaleWeave AI Discord Community](https://discord.gg/4RfZBE77fa).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -25,10 +25,17 @@
|
||||||
- [Recommended: Configure image generation](#recommended-configure-image-generation)
|
- [Recommended: Configure image generation](#recommended-configure-image-generation)
|
||||||
- [Optional: Configure websocket server](#optional-configure-websocket-server)
|
- [Optional: Configure websocket server](#optional-configure-websocket-server)
|
||||||
- [Optional: Configure world size](#optional-configure-world-size)
|
- [Optional: Configure world size](#optional-configure-world-size)
|
||||||
- [Run](#run)
|
- [Running locally](#running-locally)
|
||||||
|
- [Checklist for running locally](#checklist-for-running-locally)
|
||||||
- [Choose a world prompt or template](#choose-a-world-prompt-or-template)
|
- [Choose a world prompt or template](#choose-a-world-prompt-or-template)
|
||||||
- [Launch the game](#launch-the-game)
|
- [Launch the game](#launch-the-game)
|
||||||
- [Connect and play](#connect-and-play)
|
- [Connect and play](#connect-and-play)
|
||||||
|
- [Running on RunPod](#running-on-runpod)
|
||||||
|
- [Checklist for running on RunPod](#checklist-for-running-on-runpod)
|
||||||
|
- [Running ComfyUI on RunPod](#running-comfyui-on-runpod)
|
||||||
|
- [Running Ollama on RunPod](#running-ollama-on-runpod)
|
||||||
|
- [Upload config file to pod](#upload-config-file-to-pod)
|
||||||
|
- [Running TaleWeave AI on RunPod](#running-taleweave-ai-on-runpod)
|
||||||
|
|
||||||
## Hardware
|
## Hardware
|
||||||
|
|
||||||
|
|
@ -287,9 +294,11 @@ OLLAMA_NUM_GPU=100
|
||||||
OLLAMA_NUM_CTX=8192
|
OLLAMA_NUM_CTX=8192
|
||||||
|
|
||||||
# servers
|
# servers
|
||||||
OLLAMA_API=http://127.0.0.1:11434
|
|
||||||
DISCORD_TOKEN=YOUR_TOKEN
|
|
||||||
COMFY_API="127.0.0.1:8188"
|
COMFY_API="127.0.0.1:8188"
|
||||||
|
OLLAMA_API=http://127.0.0.1:11434
|
||||||
|
|
||||||
|
# secrets
|
||||||
|
DISCORD_TOKEN=YOUR_TOKEN
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configure the Discord bot
|
### Configure the Discord bot
|
||||||
|
|
@ -390,7 +399,33 @@ world:
|
||||||
max: 3
|
max: 3
|
||||||
```
|
```
|
||||||
|
|
||||||
## Run
|
## Running locally
|
||||||
|
|
||||||
|
### Checklist for running locally
|
||||||
|
|
||||||
|
- [ ] clone TaleWeave AI
|
||||||
|
- [ ] set up a virtual environment
|
||||||
|
- [ ] install the pip dependencies
|
||||||
|
- [ ] launch Ollama
|
||||||
|
- [ ] and pull a model
|
||||||
|
- [ ] or launch vLLM
|
||||||
|
- [ ] or get an OpenAI API key
|
||||||
|
- [ ] recommended: launch ComfyUI
|
||||||
|
- [ ] download a checkpoint
|
||||||
|
- [ ] register a Discord bot
|
||||||
|
- [ ] invite the Discord bot to your server
|
||||||
|
- [ ] configure the server environment
|
||||||
|
- [ ] set packit driver
|
||||||
|
- [ ] set packit model
|
||||||
|
- [ ] set ComfyUI API
|
||||||
|
- [ ] set Ollama API
|
||||||
|
- [ ] set Discord token
|
||||||
|
- [ ] configure the Discord bot
|
||||||
|
- [ ] set or create the `channels`
|
||||||
|
- [ ] recommended: configure the checkpoint for ComfyUI
|
||||||
|
- [ ] choose a world template
|
||||||
|
- [ ] or come up with a world prompt
|
||||||
|
- [ ] launch the game server
|
||||||
|
|
||||||
### Choose a world prompt or template
|
### Choose a world prompt or template
|
||||||
|
|
||||||
|
|
@ -464,3 +499,37 @@ that are desired for your setting. The logic system uses a combination of Python
|
||||||
connected to rooms, characters, and items in the world, influencing the behavior of the language models.
|
connected to rooms, characters, and items in the world, influencing the behavior of the language models.
|
||||||
|
|
||||||
### Connect and play
|
### Connect and play
|
||||||
|
|
||||||
|
## Running on RunPod
|
||||||
|
|
||||||
|
### Checklist for running on RunPod
|
||||||
|
|
||||||
|
- [ ] launch Ollama pod
|
||||||
|
- [ ] pull a model
|
||||||
|
- [ ] recommended: launch ComfyUI pod
|
||||||
|
- [ ] download or upload a checkpoint
|
||||||
|
- [ ] register a Discord bot
|
||||||
|
- [ ] invite the Discord bot to your server
|
||||||
|
- [ ] configure the TaleWeave AI template
|
||||||
|
- [ ] set packit driver
|
||||||
|
- [ ] set packit model
|
||||||
|
- [ ] set ComfyUI API
|
||||||
|
- [ ] set Ollama API
|
||||||
|
- [ ] set Discord token
|
||||||
|
- [ ] configure the Discord bot
|
||||||
|
- [ ] set or create the `channels`
|
||||||
|
- [ ] recommended: configure the checkpoint for ComfyUI
|
||||||
|
- [ ] choose a world template
|
||||||
|
- [ ] or come up with a world prompt
|
||||||
|
- [ ] configure TaleWeave AI template
|
||||||
|
- [ ] launch TaleWeave AI pod
|
||||||
|
- [ ] upload config
|
||||||
|
- [ ] restart pod
|
||||||
|
|
||||||
|
### Running ComfyUI on RunPod
|
||||||
|
|
||||||
|
### Running Ollama on RunPod
|
||||||
|
|
||||||
|
### Upload config file to pod
|
||||||
|
|
||||||
|
### Running TaleWeave AI on RunPod
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue