Splatlogger 1.6.3

PID (Principal ID)/PNID grabber and match logger for Splatoon

Splatlogger

A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon (Wii U), written in Python.

Prerequisites

To install the package, you'll need to have Python 3.11 or newer installed on your system. On Android devices you can use Termux. Python is not required for the Windows executable.

Both the Wii U and Cemu (Windows and Linux only) are supported.

Your Wii U will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew, such as Haxchi or the browser exploit.

On Tiramisu, use TCPGecko, Geckiine, or any other app with the TCPGecko server.

On Aroma, install the TCPGecko Aroma plugin.

Installation

On Windows, you can use the executable provided on the releases page. Though if you already have Python installed, it's recommended to use the package.

To install the package from PyPI, run:

pip install Splatlogger

(To upgrade from an older version, use pip install --upgrade)

Or download the latest release from Codeberg and run:

pip install path/to/Splatlogger-v1.x.zip

If you do have Python installed but do not wish to install the package, you can run the module directly from the source code.

Install the required dependencies:

cd path/to/Splatlogger-v1.x/ && pip install -r requirements.txt

Then run the module:

cd src/ && python -m splatlogger

Usage

Run Splatlogger with:

python -m splatlogger -ip IP [options]

where IP is your Wii U's LAN IP address (if you have your scripts directory in your PATH, you can omit python -m).

If using the Windows executable, run:

path/to/Splatlogger-1.x.exe -ip IP [options]

Options:

• -aroma - Switch to Aroma mode. Enable if using the TCPGecko Aroma plugin.

• -cemu [PID] - Switch to Cemu mode. The -ip argument is not required. Note: If you have ptrace protection enabled, you'll need to run Python as root. It's best to run the module from source in that case.

  • PID - PID of the Cemu process (optional).

• -log-level option - Set how much data should be logged.

  • none - Don't create a log file.
  • standard - Log only basic player information, the same as what's printed to the console (default).
  • extended - Log all player information and additional match information.
  • stats - Same as above with the addition of player stats (points, K/D). Requires the match to end to finish logging.

• -auto [option] - Enable auto logging. When enabled will automatically log every match you play. The log level must be at least standard.

  • all - Save a log of all matches you play (default).
  • latest - Save a log of only the latest match.

• -stack Address (in hex) - (Cemu only, optional) Beginning address of the stack space for Default Core 1 (Debug > View PPC threads). Only required for logging stats. If the default values don't work, you'll need to specify this manually.

  

• -spfn - Fetch SFID instead of PNID. Enable if playing on SPFN.

• -no-pnid - Disable fetching PNIDs.

• -silent - Disable printing logs to the console.

Logs are saved in (User)/Documents/Splatlogger/logs/.

To always run with the same IP and options without having to type them in manually, create an args.txt file in (User)/Documents/Splatlogger/ and put the arguments following splatlogger in there. Afterward any arguments passed through the command line will be ignored.

Only one program can be connected to TCPGecko at a time. If you have something else connected, disconnect it beforehand.

Credits

• pyGecko authors for the reference implementation of a Python TCPGecko library.

• Everyone who contributed to PNIDGrab and other similar PID grabbers as those were used as a reference.

• Special thanks to Pirlo for helping me with certain stuff.