Skip to main content

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

Project description

Splatlogger

A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon, 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 (e.g. Haxchi, browser exploit).

On Tiramisu, use TCPGecko (Geckiine or SDGeckiine will work as well).

On Aroma, install the TCPGecko Aroma plugin.

Installation

To install the package from PyPI, run:

python -m pip install Splatlogger

Or download the latest release from GitHub and run:

python -m pip install /path/to/Splatlogger-1.x.zip

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

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

cd /path/to/Splatlogger-1.x/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:

  • -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 (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.
  • -aroma - Switch to Aroma mode. Enable if using the TCPGecko Aroma plugin.

  • -cemu [PID] - Switch to Cemu mode. The -ip argument is not required and will be ignored.

    • PID - PID of the Cemu process (optional).
  • -stack Address (in hex) - (Cemu only) Beginning address of the stack space for Default Core 1 (Debug > View PPC threads). Reuired for logging stats, not needed otherwise.

    (example)
  • -silent - Disable printing logs to the console.

Logs are saved in /[User]/Documents/Splatlogger/logs/[Date].

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 most of tcpgecko.py.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

splatlogger-1.6.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

splatlogger-1.6-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file splatlogger-1.6.tar.gz.

File metadata

  • Download URL: splatlogger-1.6.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for splatlogger-1.6.tar.gz
Algorithm Hash digest
SHA256 81fc286fcb883a3e65022edc2d4dd63a2e8291656e982bf4bbc0994a62e23be9
MD5 48e639693cd1c87a3db95207cd0559cf
BLAKE2b-256 b746e952b023ca8d54f89afb2855dc9f648c2e20df96eee61864fcf6632828e8

See more details on using hashes here.

File details

Details for the file splatlogger-1.6-py3-none-any.whl.

File metadata

  • Download URL: splatlogger-1.6-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for splatlogger-1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ce3bd0e7868f30ada551ee57fa3060dd9e98ead151d201e3aa04742a9d7c23c7
MD5 50f925f8c230572227bb337cc733aca6
BLAKE2b-256 fa46224aa1a778096bf1f7b01edae4d31c020563061d9b933ab18ec147577be9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page