Skip to main content

A PID/PNID grabber and match logger for Splatoon using TCPGecko.

Project description

Splatlogger

A PID/PNID grabber and match logger for Splatoon using TCPGecko, written in Python.

Prerequisites

You'll need a modded Wii U running either the Tiramisu or Aroma environment, as well as Python 3.11 or newer installed on your system (only required if you're installing the package, on Android devices you can use Termux).

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, you can skip the installation and instead 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.

  • -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.5.3.tar.gz (16.6 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.5.3-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for splatlogger-1.5.3.tar.gz
Algorithm Hash digest
SHA256 bfc26b7c6acaba46f0da86652ea68bf8cc08020a60bb71fca5e3506c2645135c
MD5 22ebda0561e05f28aa76066e68771cb0
BLAKE2b-256 c6110e4bb32ac78318ab6fb0f9f0d8acae43faaffe1790794edb0649a117e385

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for splatlogger-1.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c462f1d3705ccc0d549ed209e11364ed1c2b0e8d84f007afb4137227ca7eb6cc
MD5 b4490774b45204297e8b3ca340da0c37
BLAKE2b-256 0765dd1dcf4909997c4eaf5d65cd266ad1a13ad5795f4e24efb8e31c93dd5a6c

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