Splatlogger 1.1.2__tar.gz → 1.2.0__tar.gz

{splatlogger-1.1.2/src/Splatlogger.egg-info → splatlogger-1.2.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.1.2
-Summary: PID (Principal ID)/Network ID grabber and match logger for Splatoon
+Version: 1.2.0
+Summary: PID Grabber and player/match information logging tool for Splatoon
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
 Project-URL: Source Code, https://codeberg.org/ShadowDoggo/Splatlogger
@@ -16,18 +16,20 @@ Requires-Dist: psutil
 Requires-Dist: pymemoryeditor>=2.0.0
 Requires-Dist: colorama
 Requires-Dist: clean-text
+Requires-Dist: prompt_toolkit
 Dynamic: license-file
 
 # Splatlogger
-A CLI PID (Principal ID)/Network ID grabber and match logger for Splatoon, written in Python.
+A PID Grabber and player/match information logging tool for Splatoon, supporting Wii U and Cemu*.
 
-Both the Wii U and Cemu (Windows & Linux, macOS not tested) are supported.
+<sub>*Cemu support has only been tested on Windows and Linux, though macOS should work as well.</sub>
 
 - [Prerequisites (Wii U)](#prerequisites-wii-u)
 - [Usage](#usage)
   - [Running the executable](#running-the-executable)
   - [Running with Python](#running-with-python)
   - [Options](#options)
+  - [Configuration file](#configuration-file)
   - [Troubleshooting](#troubleshooting)
 - [Important notes](#important-notes)
 - [Building the executable with PyInstaller](#building-the-executable-with-pyinstaller)
@@ -82,23 +84,27 @@ 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).
+  - `PID` - Process ID 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.
+  - `stats` - Same as above with the addition of player stats (points, K/D, win/lose) and disconnect detection. 
+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`.
+- `-a [option]`, `--auto [option]` - Enable auto logging. When enabled will automatically log every match you play. 
+Also allows you to view information about the lobby/gathering while on the matching screen.
   - `all` - Save a log of all matches you play (default).
   - `latest` - Save a log of only the latest match.
 
+    (These options don't affect anything if log level is set to `none`)
+
 - `--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.
 
@@ -109,14 +115,51 @@ instead of creating a new one for each logging session (default behavior for `--
 
 - `-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).
+For example, `splatlogger --ip 192.168.1.50 --log-level extended -a latest` will save an extended log of the latest match you play
+(replace `192.168.1.50` with your actual IP address).
+
+Logs are saved in your Documents folder in `Splatlogger/logs/`.
+
+### Configuration file
+To avoid typing the same options every time, Splatlogger automatically creates a `config.toml` file in `Documents/Splatlogger/` on first launch.
+
+You can edit this file to configure your default settings. Any command-line arguments you pass will override the settings in the config.
+
+Example `config.toml`:
+```toml
+# Splatlogger Configuration
+# Uncomment and modify settings as needed. Command-line arguments will override these values.
+# See the README for additional information.
+
+# Target Wii U LAN IP address (omit if using Cemu)
+ip = "192.168.1.50"
+
+# Target network service: "pretendo", "spfn", or "none"
+service = "pretendo"
+
+# Log level: "standard", "extended", "stats", or "none"
+log_level = "extended"
 
-Logs are saved in your documents folder in `Splatlogger/logs/`.
+# Auto logging: "all", "latest" (omit for manual logging)
+auto = "all"
 
-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.
+# Flags (true / false)
+
+# Enable single log file mode
+single_log = true
+
+# Disable printing logs to the console
+# silent = false
+
+# Cemu mode settings
+
+# Cemu process ID (set to -1 to find automatically)
+# Uncomment this option to enable Cemu mode
+# cemu = -1
+
+# Beginning address of the stack space for Default Core 1 (set only if stat logging doesn't work by default)
+# stack = "0xE101440"
+```
 
 ### Troubleshooting
 Only one program can be connected to TCPGecko at a time. If you have something else connected, disconnect it beforehand.
@@ -126,11 +169,14 @@ If it keeps failing to connect, make sure that:
 - Port 7331 isn't blocked by the firewall.
 - TCPGecko is running.
 
+There's an issue with TCPGecko where opening an applet such as the Friend List and going back into the game causes memory
+reads to fail. If auto-logging is enabled, you'll need to restart Splatlogger after returning to the game.
+
 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.
+- The data collected by Splatlogger is public player info shared by the game with every user you play with in online matches.
 
 - Network IDs and Mii names are fetched from the Pretendo or SPFN account server; this can be disabled with `--service none`.
 
@@ -162,7 +208,7 @@ 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`
+On Linux, add `--bootloader-ignore-signals` and remove `--upx-dir` and `--icon` as they are not supported.
 
 ## Acknowledgments
 - NWPlayer123 for the reference implementation of a TCPGecko library.

{splatlogger-1.1.2 → splatlogger-1.2.0}/README.md

@@ -1,13 +1,14 @@
 # Splatlogger
-A CLI PID (Principal ID)/Network ID grabber and match logger for Splatoon, written in Python.
+A PID Grabber and player/match information logging tool for Splatoon, supporting Wii U and Cemu*.
 
-Both the Wii U and Cemu (Windows & Linux, macOS not tested) are supported.
+<sub>*Cemu support has only been tested on Windows and Linux, though macOS should work as well.</sub>
 
 - [Prerequisites (Wii U)](#prerequisites-wii-u)
 - [Usage](#usage)
   - [Running the executable](#running-the-executable)
   - [Running with Python](#running-with-python)
   - [Options](#options)
+  - [Configuration file](#configuration-file)
   - [Troubleshooting](#troubleshooting)
 - [Important notes](#important-notes)
 - [Building the executable with PyInstaller](#building-the-executable-with-pyinstaller)
@@ -62,23 +63,27 @@ 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).
+  - `PID` - Process ID 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.
+  - `stats` - Same as above with the addition of player stats (points, K/D, win/lose) and disconnect detection. 
+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`.
+- `-a [option]`, `--auto [option]` - Enable auto logging. When enabled will automatically log every match you play. 
+Also allows you to view information about the lobby/gathering while on the matching screen.
   - `all` - Save a log of all matches you play (default).
   - `latest` - Save a log of only the latest match.
 
+    (These options don't affect anything if log level is set to `none`)
+
 - `--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.
 
@@ -89,14 +94,51 @@ instead of creating a new one for each logging session (default behavior for `--
 
 - `-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).
+For example, `splatlogger --ip 192.168.1.50 --log-level extended -a latest` will save an extended log of the latest match you play
+(replace `192.168.1.50` with your actual IP address).
+
+Logs are saved in your Documents folder in `Splatlogger/logs/`.
+
+### Configuration file
+To avoid typing the same options every time, Splatlogger automatically creates a `config.toml` file in `Documents/Splatlogger/` on first launch.
+
+You can edit this file to configure your default settings. Any command-line arguments you pass will override the settings in the config.
+
+Example `config.toml`:
+```toml
+# Splatlogger Configuration
+# Uncomment and modify settings as needed. Command-line arguments will override these values.
+# See the README for additional information.
+
+# Target Wii U LAN IP address (omit if using Cemu)
+ip = "192.168.1.50"
+
+# Target network service: "pretendo", "spfn", or "none"
+service = "pretendo"
+
+# Log level: "standard", "extended", "stats", or "none"
+log_level = "extended"
 
-Logs are saved in your documents folder in `Splatlogger/logs/`.
+# Auto logging: "all", "latest" (omit for manual logging)
+auto = "all"
 
-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.
+# Flags (true / false)
+
+# Enable single log file mode
+single_log = true
+
+# Disable printing logs to the console
+# silent = false
+
+# Cemu mode settings
+
+# Cemu process ID (set to -1 to find automatically)
+# Uncomment this option to enable Cemu mode
+# cemu = -1
+
+# Beginning address of the stack space for Default Core 1 (set only if stat logging doesn't work by default)
+# stack = "0xE101440"
+```
 
 ### Troubleshooting
 Only one program can be connected to TCPGecko at a time. If you have something else connected, disconnect it beforehand.
@@ -106,11 +148,14 @@ If it keeps failing to connect, make sure that:
 - Port 7331 isn't blocked by the firewall.
 - TCPGecko is running.
 
+There's an issue with TCPGecko where opening an applet such as the Friend List and going back into the game causes memory
+reads to fail. If auto-logging is enabled, you'll need to restart Splatlogger after returning to the game.
+
 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.
+- The data collected by Splatlogger is public player info shared by the game with every user you play with in online matches.
 
 - Network IDs and Mii names are fetched from the Pretendo or SPFN account server; this can be disabled with `--service none`.
 
@@ -142,7 +187,7 @@ 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`
+On Linux, add `--bootloader-ignore-signals` and remove `--upx-dir` and `--icon` as they are not supported.
 
 ## Acknowledgments
 - NWPlayer123 for the reference implementation of a TCPGecko library.

{splatlogger-1.1.2 → splatlogger-1.2.0}/pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "Splatlogger"
-version = "1.1.2"
+version = "1.2.0"
 authors = [
     { name="Shadow Doggo", email="shadowdoggo@protonmail.com" }
 ]
-description = "PID (Principal ID)/Network ID grabber and match logger for Splatoon"
+description = "PID Grabber and player/match information logging tool for Splatoon"
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
@@ -17,7 +17,8 @@ dependencies = [
     "psutil",
     "pymemoryeditor>=2.0.0",
     "colorama",
-    "clean-text"
+    "clean-text",
+    "prompt_toolkit"
 ]
 classifiers = [
     "Programming Language :: Python :: 3",

{splatlogger-1.1.2 → splatlogger-1.2.0/src/Splatlogger.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.1.2
-Summary: PID (Principal ID)/Network ID grabber and match logger for Splatoon
+Version: 1.2.0
+Summary: PID Grabber and player/match information logging tool for Splatoon
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
 Project-URL: Source Code, https://codeberg.org/ShadowDoggo/Splatlogger
@@ -16,18 +16,20 @@ Requires-Dist: psutil
 Requires-Dist: pymemoryeditor>=2.0.0
 Requires-Dist: colorama
 Requires-Dist: clean-text
+Requires-Dist: prompt_toolkit
 Dynamic: license-file
 
 # Splatlogger
-A CLI PID (Principal ID)/Network ID grabber and match logger for Splatoon, written in Python.
+A PID Grabber and player/match information logging tool for Splatoon, supporting Wii U and Cemu*.
 
-Both the Wii U and Cemu (Windows & Linux, macOS not tested) are supported.
+<sub>*Cemu support has only been tested on Windows and Linux, though macOS should work as well.</sub>
 
 - [Prerequisites (Wii U)](#prerequisites-wii-u)
 - [Usage](#usage)
   - [Running the executable](#running-the-executable)
   - [Running with Python](#running-with-python)
   - [Options](#options)
+  - [Configuration file](#configuration-file)
   - [Troubleshooting](#troubleshooting)
 - [Important notes](#important-notes)
 - [Building the executable with PyInstaller](#building-the-executable-with-pyinstaller)
@@ -82,23 +84,27 @@ 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).
+  - `PID` - Process ID 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.
+  - `stats` - Same as above with the addition of player stats (points, K/D, win/lose) and disconnect detection. 
+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`.
+- `-a [option]`, `--auto [option]` - Enable auto logging. When enabled will automatically log every match you play. 
+Also allows you to view information about the lobby/gathering while on the matching screen.
   - `all` - Save a log of all matches you play (default).
   - `latest` - Save a log of only the latest match.
 
+    (These options don't affect anything if log level is set to `none`)
+
 - `--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.
 
@@ -109,14 +115,51 @@ instead of creating a new one for each logging session (default behavior for `--
 
 - `-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).
+For example, `splatlogger --ip 192.168.1.50 --log-level extended -a latest` will save an extended log of the latest match you play
+(replace `192.168.1.50` with your actual IP address).
+
+Logs are saved in your Documents folder in `Splatlogger/logs/`.
+
+### Configuration file
+To avoid typing the same options every time, Splatlogger automatically creates a `config.toml` file in `Documents/Splatlogger/` on first launch.
+
+You can edit this file to configure your default settings. Any command-line arguments you pass will override the settings in the config.
+
+Example `config.toml`:
+```toml
+# Splatlogger Configuration
+# Uncomment and modify settings as needed. Command-line arguments will override these values.
+# See the README for additional information.
+
+# Target Wii U LAN IP address (omit if using Cemu)
+ip = "192.168.1.50"
+
+# Target network service: "pretendo", "spfn", or "none"
+service = "pretendo"
+
+# Log level: "standard", "extended", "stats", or "none"
+log_level = "extended"
 
-Logs are saved in your documents folder in `Splatlogger/logs/`.
+# Auto logging: "all", "latest" (omit for manual logging)
+auto = "all"
 
-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.
+# Flags (true / false)
+
+# Enable single log file mode
+single_log = true
+
+# Disable printing logs to the console
+# silent = false
+
+# Cemu mode settings
+
+# Cemu process ID (set to -1 to find automatically)
+# Uncomment this option to enable Cemu mode
+# cemu = -1
+
+# Beginning address of the stack space for Default Core 1 (set only if stat logging doesn't work by default)
+# stack = "0xE101440"
+```
 
 ### Troubleshooting
 Only one program can be connected to TCPGecko at a time. If you have something else connected, disconnect it beforehand.
@@ -126,11 +169,14 @@ If it keeps failing to connect, make sure that:
 - Port 7331 isn't blocked by the firewall.
 - TCPGecko is running.
 
+There's an issue with TCPGecko where opening an applet such as the Friend List and going back into the game causes memory
+reads to fail. If auto-logging is enabled, you'll need to restart Splatlogger after returning to the game.
+
 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.
+- The data collected by Splatlogger is public player info shared by the game with every user you play with in online matches.
 
 - Network IDs and Mii names are fetched from the Pretendo or SPFN account server; this can be disabled with `--service none`.
 
@@ -162,7 +208,7 @@ 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`
+On Linux, add `--bootloader-ignore-signals` and remove `--upx-dir` and `--icon` as they are not supported.
 
 ## Acknowledgments
 - NWPlayer123 for the reference implementation of a TCPGecko library.

{splatlogger-1.1.2 → splatlogger-1.2.0}/src/Splatlogger.egg-info/requires.txt

@@ -4,3 +4,4 @@ psutil
 pymemoryeditor>=2.0.0
 colorama
 clean-text
+prompt_toolkit

{splatlogger-1.1.2 → splatlogger-1.2.0}/src/splatlogger/cemu_gecko.py

@@ -1,6 +1,10 @@
 # Splatlogger (c) 2025 Shadow Doggo.
 
+from __future__ import annotations
+
 import struct
+from types import TracebackType
+from typing import Type
 
 import psutil
 from PyMemoryEditor import OpenProcess, ProcessIDNotExistsError  # type: ignore[import-untyped]
@@ -25,6 +29,13 @@ class CemuGecko:
         if self._base_address == 0:
             raise CemuGeckoError("Could not find Cemu's Wii U memory space.")
 
+    def __enter__(self) -> CemuGecko:
+        return self
+
+    def __exit__(self, exc_type: Type[BaseException] | None, exc_val: BaseException | None,
+                 exc_tb: TracebackType | None) -> None:
+        self.close()
+
     def close(self):
         """Close the process handle."""
         self._process.close()
@@ -57,6 +68,21 @@ class CemuGecko:
     def read_string(self, address: int, length: int = 1, encoding: str = "utf-8") -> str:
         return self.peek_raw(address, length).decode(encoding)
 
+    def resolve_pointer_chain(self, base_address: int, offsets: list[int]) -> int:
+        """Follow a pointer chain to its destination address starting from base_address and applying offsets."""
+        current_address = self.peek32(base_address)
+
+        for offset in offsets[:-1]:
+            if current_address == 0:
+                return 0
+
+            current_address = self.peek32(current_address + offset)
+
+        if current_address != 0 and offsets:
+            current_address += offsets[-1]
+
+        return current_address
+
     def _get_base_address(self) -> int:
         # Find Cemu's Wii U memory space and verify the pattern of bytes at the start of the game's memory.
         base_address = 0