Splatlogger 1.5__tar.gz

splatlogger-1.5/LICENSE

@@ -0,0 +1,18 @@
+The MIT License (MIT)
+
+Copyright © 2025 Shadow Doggo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+and associated documentation files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

splatlogger-1.5/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: Splatlogger
+Version: 1.5
+Summary: A PID/PNID grabber and match logger for Splatoon using TCPGecko.
+Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
+License-Expression: MIT
+Project-URL: Source Code, https://github.com/spoongaming61/Splatlogger
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: userpaths
+Requires-Dist: requests
+Dynamic: license-file
+
+# 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 Tiramisu or Aroma, as well as Python 3.11 or newer installed on your system (on Android devices you can use [Termux](https://termux.com/)).
+
+On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko) (Geckiine or SDGeckiine will work as well).
+
+On Aroma, install the [TCPGecko Aroma plugin](https://github.com/spoongaming61/TCPGeckoAroma).
+
+## Installation and Usage
+Install the package from PyPI:
+
+`python -m pip install Splatlogger`
+
+Or download and install the latest release from GitHub:
+
+`python -m pip install /path/to/Splatlogger-1.x.zip`
+
+Run Splatlogger with `splatlogger -ip IP [options]` (or `python -m splatlogger -ip IP [options]`) where `IP` is your Wii U's LAN IP address.
+
+Alternatively, you can run the script directly from the source code:
+
+`cd /path/to/Splatlogger/src && python -m splatlogger -ip IP [options]`
+
+Options:
+- `-log-level [option]` - Set how much data should be logged.
+  - `none` - Don't create a log file (default).
+  - `basic` - Log only basic player information (name, PID, PNID, region).
+  - `full` - Log all player information (basic + team, level, rank, appearance, gear, weapons).
+  - `stats` - Log all player information and player stats (points, kills, deaths). 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 `basic`).
+  - `all` - Save a log of all matches you play (default).
+  - `latest` - Save a log of only the latest match
+
+- `-aroma` - Enable Aroma mode.
+
+- `-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, create an `args.txt` file in `/[User]/Documents/Splatlogger` and put all the arguments in there.
+Afterward run Splatlogger without any arguments.
+
+Only one program can be connected to TCPGecko at a time. If you have something else connected, disconnect it beforehand.
+
+## Credits
+[pyGecko](https://github.com/wiiudev/pyGecko) authors - tcpgecko.py
+
+Everyone who contributed to [PNIDGrab](https://github.com/JerrySM64/PNIDGrab) and other similar PID grabbers as this is partly based on those.

splatlogger-1.5/README.md

@@ -0,0 +1,51 @@
+# 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 Tiramisu or Aroma, as well as Python 3.11 or newer installed on your system (on Android devices you can use [Termux](https://termux.com/)).
+
+On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko) (Geckiine or SDGeckiine will work as well).
+
+On Aroma, install the [TCPGecko Aroma plugin](https://github.com/spoongaming61/TCPGeckoAroma).
+
+## Installation and Usage
+Install the package from PyPI:
+
+`python -m pip install Splatlogger`
+
+Or download and install the latest release from GitHub:
+
+`python -m pip install /path/to/Splatlogger-1.x.zip`
+
+Run Splatlogger with `splatlogger -ip IP [options]` (or `python -m splatlogger -ip IP [options]`) where `IP` is your Wii U's LAN IP address.
+
+Alternatively, you can run the script directly from the source code:
+
+`cd /path/to/Splatlogger/src && python -m splatlogger -ip IP [options]`
+
+Options:
+- `-log-level [option]` - Set how much data should be logged.
+  - `none` - Don't create a log file (default).
+  - `basic` - Log only basic player information (name, PID, PNID, region).
+  - `full` - Log all player information (basic + team, level, rank, appearance, gear, weapons).
+  - `stats` - Log all player information and player stats (points, kills, deaths). 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 `basic`).
+  - `all` - Save a log of all matches you play (default).
+  - `latest` - Save a log of only the latest match
+
+- `-aroma` - Enable Aroma mode.
+
+- `-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, create an `args.txt` file in `/[User]/Documents/Splatlogger` and put all the arguments in there.
+Afterward run Splatlogger without any arguments.
+
+Only one program can be connected to TCPGecko at a time. If you have something else connected, disconnect it beforehand.
+
+## Credits
+[pyGecko](https://github.com/wiiudev/pyGecko) authors - tcpgecko.py
+
+Everyone who contributed to [PNIDGrab](https://github.com/JerrySM64/PNIDGrab) and other similar PID grabbers as this is partly based on those.

splatlogger-1.5/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "Splatlogger"
+version = "1.5"
+authors = [
+    { name="Shadow Doggo", email="shadowdoggo@protonmail.com" }
+]
+description = "A PID/PNID grabber and match logger for Splatoon using TCPGecko."
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "userpaths",
+    "requests"
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+
+[project.urls]
+"Source Code" = "https://github.com/spoongaming61/Splatlogger"
+
+[project.scripts]
+splatlogger = "splatlogger.__main__:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["splatlogger*"]

splatlogger-1.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

splatlogger-1.5/src/Splatlogger.egg-info/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: Splatlogger
+Version: 1.5
+Summary: A PID/PNID grabber and match logger for Splatoon using TCPGecko.
+Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
+License-Expression: MIT
+Project-URL: Source Code, https://github.com/spoongaming61/Splatlogger
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: userpaths
+Requires-Dist: requests
+Dynamic: license-file
+
+# 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 Tiramisu or Aroma, as well as Python 3.11 or newer installed on your system (on Android devices you can use [Termux](https://termux.com/)).
+
+On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko) (Geckiine or SDGeckiine will work as well).
+
+On Aroma, install the [TCPGecko Aroma plugin](https://github.com/spoongaming61/TCPGeckoAroma).
+
+## Installation and Usage
+Install the package from PyPI:
+
+`python -m pip install Splatlogger`
+
+Or download and install the latest release from GitHub:
+
+`python -m pip install /path/to/Splatlogger-1.x.zip`
+
+Run Splatlogger with `splatlogger -ip IP [options]` (or `python -m splatlogger -ip IP [options]`) where `IP` is your Wii U's LAN IP address.
+
+Alternatively, you can run the script directly from the source code:
+
+`cd /path/to/Splatlogger/src && python -m splatlogger -ip IP [options]`
+
+Options:
+- `-log-level [option]` - Set how much data should be logged.
+  - `none` - Don't create a log file (default).
+  - `basic` - Log only basic player information (name, PID, PNID, region).
+  - `full` - Log all player information (basic + team, level, rank, appearance, gear, weapons).
+  - `stats` - Log all player information and player stats (points, kills, deaths). 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 `basic`).
+  - `all` - Save a log of all matches you play (default).
+  - `latest` - Save a log of only the latest match
+
+- `-aroma` - Enable Aroma mode.
+
+- `-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, create an `args.txt` file in `/[User]/Documents/Splatlogger` and put all the arguments in there.
+Afterward run Splatlogger without any arguments.
+
+Only one program can be connected to TCPGecko at a time. If you have something else connected, disconnect it beforehand.
+
+## Credits
+[pyGecko](https://github.com/wiiudev/pyGecko) authors - tcpgecko.py
+
+Everyone who contributed to [PNIDGrab](https://github.com/JerrySM64/PNIDGrab) and other similar PID grabbers as this is partly based on those.

splatlogger-1.5/src/Splatlogger.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+src/Splatlogger.egg-info/PKG-INFO
+src/Splatlogger.egg-info/SOURCES.txt
+src/Splatlogger.egg-info/dependency_links.txt
+src/Splatlogger.egg-info/entry_points.txt
+src/Splatlogger.egg-info/requires.txt
+src/Splatlogger.egg-info/top_level.txt
+src/splatlogger/__init__.py
+src/splatlogger/__main__.py
+src/splatlogger/data.py
+src/splatlogger/match_logger.py
+src/splatlogger/tcpgecko.py
+src/splatlogger/tcpgecko_aroma.py

splatlogger-1.5/src/Splatlogger.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

splatlogger-1.5/src/Splatlogger.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+splatlogger = splatlogger.__main__:main

splatlogger-1.5/src/Splatlogger.egg-info/requires.txt

@@ -0,0 +1,2 @@
+userpaths
+requests

splatlogger-1.5/src/Splatlogger.egg-info/top_level.txt

@@ -0,0 +1 @@
+splatlogger

splatlogger-1.5/src/splatlogger/__main__.py

@@ -0,0 +1,286 @@
+# Splatlogger (c) 2025 Shadow Doggo.
+
+import os
+import sys
+import time
+import argparse
+import requests
+import ipaddress
+import userpaths  # type: ignore[import-untyped]
+import xml.etree.ElementTree as ElementTree
+from datetime import datetime
+
+from .data import Pointers, Offsets, PlayerInfo
+from .match_logger import MatchLogger
+from .tcpgecko import TCPGecko, TCPGeckoException
+from .tcpgecko_aroma import TCPGeckoAroma
+
+_VERSION: str = "1.5"
+
+
+def main() -> None:
+    def splatlog(match_count: int) -> None:
+        request_fail: bool = False
+        request_errors: list[str] = []
+        session_id: int = 0
+        player_count: int = 8
+        player_info_list: list[PlayerInfo] = []
+
+        if session_adr != 0:
+            session_id_idx: int = int.from_bytes(gecko.peek_raw(session_adr + Offsets.SESSION_ID_IDX, length=0x1),
+                                                 byteorder="big")
+            session_id = gecko.peek32(session_adr + session_id_idx * 4 + Offsets.SESSION_ID)
+
+        main_mgr_base_adr: int = gecko.peek32(Pointers.MAIN_MGR_BASE)
+        if main_mgr_base_adr != 0:
+            player_mgr_adr: int = gecko.peek32(main_mgr_base_adr + Offsets.PLAYER_MGR)
+            if player_mgr_adr != 0:
+                player_count = gecko.peek8(player_mgr_adr + Offsets.PLAYER_COUNT)
+        else:
+            print("You are currently not in a match. Logging previous match data "
+                  "(Player 1 data will be your own, Session ID will be the current one).\n")
+
+        player_idx: int
+        for player_idx in range(player_count):
+            player_info_adr: int = gecko.peek32(player_info_ary_adr + player_idx * 0x4)
+            player_info_raw: bytes = gecko.peek_raw(player_info_adr, length=0xD4)
+
+            player_pid: int = int.from_bytes(player_info_raw[0xD0:0xD4], byteorder="big")
+            if player_pid != 0:
+                player_name: str = (player_info_raw[0x6:0x26]
+                                    .decode("utf-16-be")
+                                    .split("\u0000")[0]
+                                    .replace("\n", "")
+                                    .replace("\r", ""))
+
+                player_pnid: str = ""
+                player_mii_name: str = ""
+                request_error: str = ""
+                request_retry_count: int = 0
+                while request_retry_count < 3:
+                    try:
+                        response: requests.Response = requests.get(
+                            f"https://account.pretendo.cc/v1/api/miis?pids={player_pid}",
+                            headers={"X-Nintendo-Client-ID": "a2efa818a34fa16b8afbc8a74eba3eda",
+                                     "X-Nintendo-Client-Secret": "c91cdb5658bd4954ade78533a339cf9a"},
+                            timeout=10
+                        )
+
+                        root: ElementTree.Element[str] = ElementTree.fromstring(response.text)
+                        assert (isinstance(root[0].find("user_id"), ElementTree.Element) and
+                                isinstance(root[0].find("name"), ElementTree.Element))
+                        player_pnid = root[0].find("user_id").text  # type: ignore
+                        player_mii_name = (root[0].find("name")  # type: ignore
+                                           .text
+                                           .replace("\n", "")
+                                           .replace("\r", ""))
+                        request_fail = False
+                        break
+                    except (requests.HTTPError, AssertionError) as ex:
+                        request_fail = True
+                        request_error = str(ex)
+                        request_retry_count += 1
+                        time.sleep(1)
+
+                if request_fail and request_error not in request_errors:
+                    request_errors.append(request_error)
+
+                if log_level != "none":
+                    player_info: PlayerInfo = PlayerInfo(
+                        index=player_idx,
+                        pid=player_pid,
+                        pnid=player_pnid,
+                        name=player_name,
+                        mii_name=player_mii_name,
+                        region=int.from_bytes(player_info_raw[0x2C:0x30], byteorder="big"),
+                        team=int.from_bytes(player_info_raw[0x33:0x34], byteorder="big"),
+                        gender=int.from_bytes(player_info_raw[0x37:0x38], byteorder="big"),
+                        skin_tone=int.from_bytes(player_info_raw[0x3B:0x3C], byteorder="big"),
+                        eye_color=int.from_bytes(player_info_raw[0x3F:0x40], byteorder="big"),
+                        weapon=int.from_bytes(player_info_raw[0x46:0x48], byteorder="big"),
+                        sub_weapon=int.from_bytes(player_info_raw[0x4A:0x4C], byteorder="big"),
+                        special_weapon=int.from_bytes(player_info_raw[0x4D:0x50], byteorder="big"),
+                        shoes=int.from_bytes(player_info_raw[0x54:0x58], byteorder="big"),
+                        clothes=int.from_bytes(player_info_raw[0x70:0x74], byteorder="big"),
+                        headgear=int.from_bytes(player_info_raw[0x8C:0x90], byteorder="big"),
+                        level=int.from_bytes(player_info_raw[0xAF:0xB0], byteorder="big", signed=True) + 1,
+                        rank=int.from_bytes(player_info_raw[0xB3:0xB4], byteorder="big", signed=True)
+                    )
+                    player_info_list.append(player_info)
+
+                if not silent_logging:
+                    print(f"Player {player_idx + 1} | "
+                          f"PID: {player_pid:X} ({player_pid}) {' ' * 16 if player_pid == 0 else ''}| "
+                          f"PNID: {player_pnid} {' ' * (16 - len(player_pnid))}| "
+                          f"Name: {player_name}"
+                          f"{' (Mii name: ' + player_mii_name + ')' if player_name != player_mii_name else ''}")
+
+        if not silent_logging:
+            print()
+            if request_fail:
+                print("Failed to get account data for one or more players: "
+                      f"{'; '.join(request_errors)}\n")
+
+            if session_id != 0:
+                print(f"Session ID: {session_id:X} ({session_id})")
+            else:
+                print("Session ID: None")
+
+            print(f"Time: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
+
+        if log_level != "none":
+            match_logger.log_match(session_id, match_count, player_info_list)
+
+    # Main driver code.
+    epic_fail: bool = False
+    retry_count: int = 0
+
+    print(f"Splatlogger v{_VERSION} by Shadow Doggo\n")
+
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
+        description="A PID/PNID grabber and match logger for Splatoon using TCPGecko."
+    )
+    parser.add_argument("-ip", help="Your Wii U's LAN IP address.", required=True)
+    parser.add_argument("-log-level", help="Set how much data should be logged (see README).",
+                        choices=["none", "basic", "full", "stats"], nargs="?", const="none", default="none")
+    parser.add_argument("-auto",
+                        help="Enable auto logging (all to log every match, latest to only log the latest match).",
+                        choices=["all", "latest"], nargs="?", const="all")
+    parser.add_argument("-aroma", help="Enable Aroma mode.", action="store_true")
+    parser.add_argument("-silent", help="Disable printing logs to the console.", action="store_true")
+
+    args: argparse.Namespace
+    if os.path.isfile(f"{userpaths.get_my_documents()}/Splatlogger/args.txt"):
+        with open(f"{userpaths.get_my_documents()}/Splatlogger/args.txt") as f:
+            args = parser.parse_args(f.read().split())
+    else:
+        args = parser.parse_args()
+
+    log_level: str = args.log_level
+    silent_logging: bool = args.silent
+    auto_logging: bool = True if args.auto in ("all", "latest") else False
+    log_latest: bool = True if args.auto == "latest" else False
+    aroma: bool = True if args.aroma else False
+
+    gecko: TCPGecko
+    try:
+        ipaddress.ip_address(args.ip)
+        print(f"Connecting to: {args.ip}")
+        gecko = TCPGeckoAroma(args.ip) if aroma else TCPGecko(args.ip)
+    except ValueError:
+        print("Please provide a valid IP address.\nExiting.")
+        sys.exit()
+    except OSError as e:
+        print(f"Failed to connect: {e}\nExiting.")
+        sys.exit()
+
+    static_mem_adr: int = 0
+    session_adr: int = 0
+    player_info_ary_adr: int = 0
+    while retry_count < 3:
+        try:
+            static_mem_adr = gecko.peek32(Pointers.STATIC_MEM)
+            session_adr = gecko.peek32(Pointers.SESSION)
+            player_info_ary_adr = gecko.peek32(static_mem_adr + Offsets.PLAYER_INFO_ARY)
+
+            epic_fail = False
+            break
+        except (OSError, TimeoutError, TCPGeckoException) as e:
+            print(f"\nAn error has occurred: {e}\nRetrying in 10 seconds...")
+            epic_fail = True
+            time.sleep(10)
+
+    if epic_fail:
+        print("\nFailed after 3 retries. Exiting.")
+        sys.exit()
+
+    print("Connected.\n")
+    retry_count = 0
+
+    match_logger: MatchLogger
+    if log_level != "none" and not auto_logging:
+        match_logger = MatchLogger(gecko, log_level, auto_logging, aroma, static_mem_adr)
+        try:
+            match_logger.create_new_log()
+        except OSError as e:
+            print(f"Failed to create log file: {e}\nExiting.")
+            sys.exit()
+
+    if log_level != "none" and auto_logging:
+        print("Auto logging enabled.")
+
+        match_logger = MatchLogger(gecko, log_level, auto_logging, aroma, static_mem_adr)
+        try:
+            match_logger.create_new_log()
+        except OSError as e:
+            print(f"Failed to create log file: {e}\nExiting.")
+            sys.exit()
+
+        match_in_progress: bool = False
+        count: int = 0
+        while True:
+            try:
+                main_mgr_vs_game_adr: int = gecko.peek32(Pointers.MAIN_MGR_VS_GAME)
+                if main_mgr_vs_game_adr == 0:
+                    match_in_progress = False
+
+                if not match_in_progress and main_mgr_vs_game_adr != 0:  # Trigger logging when a VS match is loaded.
+                    match_in_progress = True
+                    session_adr = gecko.peek32(Pointers.SESSION)
+                    count += 1
+
+                    if log_latest:
+                        match_logger.create_new_log()
+
+                    if not silent_logging:
+                        print(f"\nMatch {count}\n")
+
+                    time.sleep(1)
+                    while retry_count < 3:
+                        try:
+                            splatlog(count)
+                            epic_fail = False
+                            break
+                        except (OSError, TimeoutError, TCPGeckoException) as e:
+                            print(f"\nAn error has occurred: {e}\nRetrying in 10 seconds...")
+                            epic_fail = True
+                            retry_count += 1
+                            time.sleep(10)
+
+                    if epic_fail:
+                        print("\nFailed after 3 retries. Exiting.")
+                        sys.exit()
+
+                retry_count = 0
+                time.sleep(10)
+            except KeyboardInterrupt:
+                print("\nExiting.")
+                break
+            except (OSError, TimeoutError, TCPGeckoException) as e:
+                if retry_count < 3:
+                    print(f"\nAn error has occurred: {e}\nRetrying in 10 seconds...")
+                    retry_count += 1
+                    time.sleep(10)
+                else:
+                    print("\nFailed after 3 retries. Exiting.")
+                    break
+
+    if not auto_logging:
+        while retry_count < 3:
+            try:
+                splatlog(match_count=1)
+                epic_fail = False
+                break
+            except (OSError, TimeoutError, TCPGeckoException) as e:
+                print(f"\nAn error has occurred: {e}\nRetrying in 10 seconds...")
+                epic_fail = True
+                retry_count += 1
+                time.sleep(10)
+
+        if epic_fail:
+            print("\nFailed after 3 retries. Exiting.")
+            sys.exit()
+
+
+if __name__ == "__main__":
+    main()