From df48cb7fb4ff247476d5fb193832a438a472266d Mon Sep 17 00:00:00 2001 From: Sean Sube Date: Wed, 8 May 2024 22:55:02 -0500 Subject: [PATCH] add example env --- README.md | 56 ++++++++++++++++++++++++++++++++++++----------------- example.env | 8 ++++++++ 2 files changed, 46 insertions(+), 18 deletions(-) create mode 100644 example.env diff --git a/README.md b/README.md index a420728..80f0f44 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,24 @@ At the core of TaleWeave AI is the AI-powered dungeon master, which not only gui 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. +captivate and engage players' imaginations. + +## Contents + +- [TailWeave AI](#tailweave-ai) + - [Contents](#contents) + - [Features](#features) + - [Installation](#installation) + - [Step 1: Clone the Repository](#step-1-clone-the-repository) + - [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: Run the Game Server](#step-5-run-the-game-server) + - [Documentation](#documentation) + - [Contributing](#contributing) + - [Support and Community](#support-and-community) + - [License](#license) + - [TODOs](#todos) ## Features @@ -51,29 +68,33 @@ larger tapestry of the tale. ## Installation -**Step 1: Clone the Repository** +### Step 1: Clone the Repository ```bash -git clone https://github.com/your-github-username/TaleWeaveAI.git +git clone https://github.com/ssube/TaleWeaveAI.git cd TaleWeaveAI ``` -**Step 2: Set Up Your Environment** +### Step 2: Set Up Your Environment ```bash +# 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** +### 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** +### Step 4: Run the Dependencies Launch Comfy UI for image generation and Ollama for text generation. -**Step 5: Run the Game Server** +### Step 5: Run the Game Server To start a game simulation using the "outback animals" example prompt and running both the Discord both and websocket server: @@ -84,7 +105,7 @@ python3 -m adventure.main \ --world-prompt ./adventure/prompts.yml:outback-animals \ --discord=true \ --server=true \ - --rooms 6 \ + --rooms 3 \ --steps 30 \ --optional-actions=true \ --actions adventure.sim_systems:init_actions \ @@ -93,10 +114,10 @@ python3 -m adventure.main \ # --systems adventure.custom_systems:init_logic ``` -This will 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, although the step in progress will be lost. The saved state can be resumed and played for any -number of steps. +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. 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. @@ -112,21 +133,20 @@ please refer to our [Documentation](./docs). This guide includes comprehensive i ## Contributing -TaleWeave AI is a community-driven project, and we welcome contributions of all kinds. If you're interested in improving the engine or adding new features, please check out our contributing guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md). +TaleWeave AI is a community-driven project, and we welcome contributions of all kinds. If you're interested in improving +the engine or adding new features, please check out our contributing guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md). ## 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: [TaleWeave AI Discord 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: [TaleWeave AI Discord Community](#) ## License TaleWeave AI is released under the MIT License. See the [LICENSE](./LICENSE) file for more details. ---- - -This continuation of the README provides clear instructions and necessary resources for users and contributors to effectively engage with and utilize the TaleWeave AI platform. - ## TODOs - admin panel in web UI - store long-term memory for actors in vector DB +- generate and simulate should probably be async diff --git a/example.env b/example.env new file mode 100644 index 0000000..5883a26 --- /dev/null +++ b/example.env @@ -0,0 +1,8 @@ +PACKIT_DRIVER=ollama +PACKIT_MODEL=dolphin-llama3:70b +#OLLAMA_NUM_GPU=81 +OLLAMA_NUM_CTX=8192 +#OLLAMA_API=https://abc-123.proxy.runpod.net + +COMFY_API="127.0.0.1:8188" +DISCORD_TOKEN=bot-token-here