Skip to content

vermilion10/gakumasRPC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gakuen Idolmaster (Gakumas) Discord Rich Presence

Python Discord RPC

A lightweight Python script to display your Gakuen Idolmaster (学園アイドルマスター) status on Discord. It automatically detects when the game is running and updates your activity status accordingly.

Preview

Download & Run (No Setup Required)

For users who don't want to install Python:

  1. Go to the Releases Page.
  2. Download the file named GakumasRPC.exe from the "Assets" section.
  3. Double-click the file to run it.
  4. Open your game. That's it!

(If Windows Defender shows a warning, click "More Info" -> "Run Anyway")

Features

  • Auto-Detection: Automatically detects when gakumas.exe is running.
  • Background Process: Runs silently in the background without opening a console window.
  • Low Resource Usage: Efficient polling using psutil.
  • Auto-Connect: Automatically connects/disconnects from Discord RPC when the game opens or closes.

Prerequisites

Installation

  1. Clone the repository

    git clone https://github.com/vermilion10/gakumasRPC
    cd gakumasRPC
  2. Create a Virtual Environment (Recommended) It's best practice to use a virtual environment to keep dependencies clean.

    python -m venv venv
  3. Activate the Virtual Environment

    • Windows (CMD):
    venv\Scripts\activate
    • Windows (PowerShell):
    .\venv\Scripts\Activate.ps1
  4. Install Dependencies

    pip install -r requirements.txt

Configuration (Launcher Setup)

Since this script uses a virtual environment, we need a batch file (.bat) to launch it correctly using the pythonw.exe inside the venv (which hides the console window).

  1. Duplicate the template: Copy run_status_template.bat and rename it to run_status.bat.

  2. Edit the file: Right-click run_status.bat and select Edit. Update the paths to match your actual folder location. Example:

    @echo off
    start "" "C:\Users\YOUR_NAME\gakumasRPC\venv\Scripts\pythonw.exe" "C:\Users\YOUR_NAME\gakumasRPC\gakumas_rpc\gakumas_rpc.pyw"
    exit
  3. Test it: Double-click run_status.bat. If no window appears but the process is running in Task Manager, it works!

How to Auto-Start on Windows Boot

You don't need to run this script manually every time. Follow these steps to make it run automatically when you turn on your PC:

  1. Press Win + R on your keyboard to open the Run dialog.
  2. Type shell:startup and press Enter. This opens the Windows Startup folder.
  3. Create a Shortcut:
    • Right-click your configured run_status.bat file.
    • Select Create Shortcut.
    • Move (Cut & Paste) that shortcut into the Startup folder you just opened.
  4. Done! The script will now silently start whenever you log in to Windows and wait for you to play Gakumas.

Disclaimer

This project is a fan-made tool and is not affiliated with Bandai Namco.

About

A lightweight Python script to add Discord Rich Presence (RPC) support for Gakuen Idolmaster (学園アイドルマスター).

Topics

Resources

Stars

Watchers

Forks

Contributors