vrr/talemate
2
0
Fork 0
mirror of https://github.com/vegu-ai/talemate.git synced 2025-09-02 02:19:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update installation docs

Browse source
This commit is contained in:
vegu-ai-tools 2025-05-09 22:27:44 +03:00
parent bd7d4a2e7f
commit 98fcaf6bad
4 changed files with 25 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/getting-started/installation/linux.md
View file

@ -1,13 +1,12 @@
## Quick install instructions
!!! warning
python 3.12 is currently not supported.
### Dependencies
--8<-- "docs/snippets/common.md:python-versions"
1. node.js and npm - see instructions [here](https://nodejs.org/en/download/package-manager/)
1. python 3.10 or 3.11 - see instructions [here](https://www.python.org/downloads/)
1. python- see instructions [here](https://www.python.org/downloads/)
### Installation

26
docs/getting-started/installation/windows.md
View file

@ -1,25 +1,28 @@
## Quick install instructions
!!! warning
python 3.12 is currently not supported
1. Download and install Python 3.10 or Python 3.11 from the [official Python website](https://www.python.org/downloads/windows/).
1. Download and install Python 3.10 - 3.13 from the [official Python website](https://www.python.org/downloads/windows/).
- [Click here for direct link to python 3.11.9 download](https://www.python.org/downloads/release/python-3119/)
1. Download and install Node.js from the [official Node.js website](https://nodejs.org/en/download/prebuilt-installer). This will also install npm.
1. Download the Talemate project to your local machine. Download from [the Releases page](https://github.com/vegu-ai/talemate/releases).
1. Unpack the download and run `install.bat` by double clicking it. This will set up the project on your local machine.
1. **Optional:** If you are using an nvidia graphics card with CUDA support you may want to also run `install-cuda.bat` **afterwards**, to install the cuda enabled version of torch - although this is only needed if you want to run some bigger embedding models where CUDA can be helpful.
1. Once the installation is complete, you can start the backend and frontend servers by running `start.bat`.
1. Navigate your browser to http://localhost:8080
1. Once the talemate logo shows up, navigate your browser to http://localhost:8080
!!! note "First start up may take a while"
We have seen cases where the first start of talemate will sit at a black screen for a minute or two. Just wait it out, eventually the Talemate logo should show up.
If everything went well, you can proceed to [connect a client](../../connect-a-client).
## Additional Information
### How to Install Python 3.10 or 3.11
### How to Install Python
--8<-- "docs/snippets/common.md:python-versions"
1. Visit the official Python website's download page for Windows at [https://www.python.org/downloads/windows/](https://www.python.org/downloads/windows/).
2. Find the latest version of Python 3.10 or 3.11 and click on one of the download links. (You will likely want the Windows installer (64-bit))
4. Run the installer file and follow the setup instructions. Make sure to check the box that says Add Python 3.10 to PATH before you click Install Now.
2. Find the latest updated of Python 3.13 and click on one of the download links. (You will likely want the Windows installer (64-bit))
4. Run the installer file and follow the setup instructions. Make sure to check the box that says Add Python 3.13 to PATH before you click Install Now.
### How to Install npm
@ -35,6 +38,13 @@ This batch file is used to set up the project on your local machine. It creates
To run this file, simply double click on it or open a command prompt in the same directory and type `install.bat`.
#### update.bat
If you are inside a git checkout of talemate you can use this to pull and reinstall talemate if there have been updates.
!!! note "CUDA needs to be reinstalled manually"
Running `update.bat` will downgrade your torch install to the non-CUDA version, so if you want CUDA support you will need to run the `install-cuda.bat` script after the update is finished.
#### start.bat
This batch file is used to start the backend and frontend servers. It opens two command prompts, one for the frontend and one for the backend.

3
docs/index.md
View file

@ -4,9 +4,6 @@ Roleplay with AI with a focus on strong narration and consistent world and game
:material-github: [GitHub](https://github.com/vegu-ai/talemate)
!!! note "Version 0.26.0 and later"
This documenation is for version 0.26.0 and later - previous versions are significantly different, and some of the information here may not apply. This is especially true for the world state mangement and creative tools.
## Getting Started

4
docs/snippets/common.md Normal file
View file

@ -0,0 +1,4 @@
<!--- --8<-- [start:python-versions] -->
!!! note "Supported Versions"
As of Talemate `0.30` the following python versions are supported: `3.10`, `3.11`, `3.12` or `3.13`
<!--- --8<-- [end:python-versions] -->