Setting up Butler on Windows

Using the itch.io app

If you have the itch app installed on your Windows computer, it comes bundled with Butler. We recommend using this version as it will automatically be updated if you use the itch.io app. Here’s how to configure your system to use this version of Butler:

1. Locate Butler’s executable: First, you need to locate where the itch app is installed. By default, the itch app is installed in the %APPDATA%/itch folder. Inside that, you will find the Butler executable in apps/butler.

2. Add Butler to PATH: After locating the Butler executable, you need to add it to your system’s PATH so you can run it from any command prompt. Here’s how:

   • Press Win + X and choose System.
   • Click on Advanced system settings.
   • Click on Environment Variables.
   • Under System variables, find and select Path, then click on Edit.
   • Click on New and then add the path where Butler is located, e.g., %APPDATA%\itch\apps\butler.
   • Click OK on all windows to save the changes.

3. Open Command Prompt: Press Win + R, type cmd, and hit Enter to open the Command Prompt.

4. Authenticate Butler: In the Command Prompt, type butler login and hit Enter. This will open a new browser window where you can log in to your itch.io account and allow Butler to access your account.

Your computer is now ready to use Butler from the Command Prompt.

Manual Install

If you don’t with to use the itch.io app or you want to manually manage the version of Butler you use, you can follow the following instructions to install it:

1. Download Butler: First, you need to download Butler. You can get the Windows version of Butler from the following URL: https://itch.io/docs/butler/installing.html

2. Install Butler: After downloading, you’ll get a .zip file. Extract it to a location of your choice. For the sake of simplicity, let’s say you extract it to C:\butler.

3. Add Butler to PATH: Next, you need to add Butler to your system’s PATH so you can run it from any command prompt. Here’s how:

   • Press Win + X and choose System.
   • Click on Advanced system settings.
   • Click on Environment Variables.
   • Under System variables, find and select Path, then click on Edit.
   • Click on New and then add the path where you extracted Butler, e.g., C:\butler.
   • Click OK on all windows to save the changes.

4. Open Command Prompt: Press Win + R, type cmd, and hit Enter to open the Command Prompt.

5. Authenticate Butler: In the Command Prompt, type butler login and hit Enter. This will open a new browser window where you can log in to your itch.io account and allow Butler to access your account.

Your computer is now ready to use Butler from the Command Prompt.