Splatlogger

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

Both the Wii U and Cemu (Windows & Linux, macOS not tested) are supported.

• Prerequisites (Wii U)
• Usage
  • Running the executable
  • Running with Python
  • Options
  • Troubleshooting
• Important notes
• Building the executable with PyInstaller
• Acknowledgments
• License

Prerequisites (Wii U)

Your console 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, use TCPGecko-Plugin.

Usage

Running the executable

Windows and Linux executables are provided on the Releases page.

Run Splatlogger with:

path/to/Splatlogger-executable --ip IP [options]

where IP is your Wii U's LAN IP address.

Open a command prompt/terminal window and drag the executable into it to automatically get the path.

Running with Python

You can install Splatlogger as a package from PyPI:

pip install Splatlogger

The run with:

splatlogger --ip IP [options]

(if that fails, try python -m splatlogger) where IP is your Wii U's LAN IP address.

To run from source instead, download the latest source archive from the Releases page and extract it, then open a terminal window in the extracted directory.

Install the required dependencies:

pip install -r requirements.txt

Then move into the src directory and run:

python -m splatlogger --ip IP [options]

Options

• -c [PID], --cemu [PID] - Switch to Cemu mode. The --ip argument is not required.

  • 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; if it ends abruptly, the stats won't be logged.

• --service - Choose which network service you're using.

  • none - Disable fetching account info.
  • pretendo - Pretendo Network (default).
  • spfn - Splatfestival Network.

• -a [option], --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.

  

• -sl, --single-log - Enable single log mode. When enabled, only one log file will be created for each day and logging will resume in that file instead of creating a new one for each logging session (default behavior for --auto latest).

• -s, --silent - Disable printing logs to the console.

For example, splatlogger --ip 192.168.1.100 --log-level extended --auto latest will save an extended log of the latest match you play (replace 192.168.1.100 with your actual IP address).

Logs are saved in your documents folder in Splatlogger/logs/.

To always run with the same IP and options without having to type them in manually, create a options.txt file in (User)/Documents/Splatlogger/ and put them in there. Afterward, run splatlogger without any arguments.

Troubleshooting

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

If it keeps failing to connect, make sure that:

• Your device and Wii U are on the same local network.
• Port 7331 isn't blocked by the firewall.
• TCPGecko is running.

For Cemu users on Linux, if you have ptrace protection enabled, you'll need to run Python as root. In that case, it's best to run the package from source or use the executable instead.

Important notes

• The data collected by Splatlogger is public player info shared by the game with every user you encounter in online matches.

• Network IDs and Mii names are fetched from the Pretendo or SPFN account server; this can be disabled with --service none.

• Splatlogger does not collect any sensitive information such as account email addresses or IP addresses.

• All data collected stays on your machine and is not sent anywhere.

• Please handle the logs responsibly. I do not encourage sharing other users' data without their permission, even if no real harm can be done with it.

Building the executable with PyInstaller

Set up a virtual environment and install PyInstaller as well as the required dependencies.

In match_logger.py, replace from importlib import resources with import sys and

names_path = resources.files(__package__).joinpath("resources", "names.json")

with

names_path = Path(sys._MEIPASS) / "resources/names.json"

Then run:

pyinstaller --noconfirm --onefile --console --name "Splatlogger-v1.x" --upx-dir "path/to/upx" --optimize "2" --add-data "path/to/Splatlogger/src/splatlogger/resources:resources/" --icon "NONE" "path/to/Splatlogger/src/run.py"

replacing the placeholder paths with the actual ones.

You can omit --upx-dir if you're not using UPX to compress the executable and --optimize "2" to disable bytecode optimization.

On Linux, add --bootloader-ignore-signals

Acknowledgments

• NWPlayer123 for the reference implementation of a TCPGecko library.

• Everyone who found or helped me with finding the addresses/pointers used in this project, including: vyrval, javiig8, Tombuntu, oomi_the_octo and Pirlo.

• c8ff/winterberry for finding a method to get Cemu's base address without reading the log file.

License

This project is licensed under the MIT License.

The executables include third-party components; their license texts are contained in THIRD_PARTY_LICENSES.md.