How to install - pseja/TurtlePresence GitHub Wiki

1. Prerequisites

  • You must have Python 3 installed on your system.
  • If you're not using the Turtle WoW launcher you have to setup SuperWoW; you can read about that here.

2. Create a Discord Application

To use Discord's Rich Presence, you need to create a personal developer application:

  1. Go to the Discord Developer Portal and click on New Application
  2. Give it a name you want to show on Discord, for example Turtle WoW, tick the box and Create it.
  3. Copy the APPLICATION ID on the General Information page. You will need this for the Python setup part.
  4. Navigate to the Rich Presence page, click on Add Image(s), upload all images in this addons images directory, and click on Save Changes.

3. Configure the Python Script

You now need to tell the script where your game is installed and provide it with the APPLICATION ID from step 2.3.

  1. Locate your Turtle WoW addon directory.
  2. Open the script/TurtlePresence.py in any text editor.
  3. Update the TWOW_PATH variable with the full path to your Turtle WoW installation directory with the same format as there is already.
  4. Update the CLIENT_ID variable by pasting the APPLICATION ID you copied in step 2.3.

For example like this:

TWOW_PATH = "E:\\TWoW"
CLIENT_ID = "1234567890987654321"

4. Install the Python Dependencies

This script requires external Python libraries to function.

  1. Open a terminal or command prompt inside the TurtlePresence addon directory.
  2. Install the required packages by running: pip install -r requirements.txt

5. Configure In-Game Addons

This addon requires a specific launcher setup to work correctly.

You can skip these steps if you're not using the Turtle WoW launcher.

  1. Open the Turtle WoW launcher and go to the MODS section.
  2. DISABLE the official discordOverlay mod.
  3. ENABLE the SuperWoWhook mod. This is required for the addon to export character data.

6. Running the Addon

For the Rich Presence to work, the Python script must run before you Enter World or you'll get the Failed to update Discord presence: Unknown error error message.

  1. Run the Python script in the script/TurtlePresence.py.
  2. Launch Turtle WoW and Enter World.

To make this easier, you can create a small script to launch the script before you launch the game.

For Windows (for example run.bat):

@echo off
REM change this to your Turtle WoW installation path
set "TWOW_PATH="E:\TWoW"

echo Starting TurtlePresence script...
start "TurtlePresence" python "%TWOW_PATH%\Interface\AddOns\TurtlePresence\script\TurtlePresence.py"

echo Launching Turtle WoW...
cd /d "%TWOW_PATH%\TurtleWoW"
start turtle-wow.exe

exit

The same could be done for Linux.