Splatlogger 1.2.2__tar.gz → 1.2.4__tar.gz

{splatlogger-1.2.2 → splatlogger-1.2.4}/PKG-INFO

@@ -1,22 +1,26 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.2.2
+Version: 1.2.4
 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
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: tomli>=1.1.0; python_version < "3.11"
 Requires-Dist: userpaths>=0.1.3
 Requires-Dist: requests>=2.28.0
-Requires-Dist: psutil>=5.9.0
-Requires-Dist: pymemoryeditor>=2.0.0
 Requires-Dist: colorama>=0.4.6
 Requires-Dist: clean-text>=0.7.1
 Requires-Dist: prompt_toolkit>=3.0.0
+Provides-Extra: cemu
+Requires-Dist: psutil>=5.9.0; extra == "cemu"
+Requires-Dist: pymemoryeditor>=2.0.0; extra == "cemu"
+Provides-Extra: build
+Requires-Dist: pyinstaller>=6.6.0; extra == "build"
 Dynamic: license-file
 
 # Splatlogger
@@ -47,13 +51,14 @@ On Aroma, use [TCPGecko-Plugin](https://github.com/PinkDiamondTeam/TCPGecko-Plug
 
 ## Usage
 ### Running the executable
-Windows and Linux executables are provided on the Releases page.
+Windows and Linux executables are provided on the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest) page.
 
 Run Splatlogger with:
 ```
-path/to/Splatlogger-executable --ip IP [options]
+path/to/Splatlogger-executable --ip IP [options] / --cemu [PID] [options]
 ```
-where `IP` is your Wii U's LAN IP address.
+Use the `--ip` target where `IP` is your Wii U's LAN IP address,
+or the `-c` / `--cemu` target to enable Cemu mode where `PID` is the process ID of the Cemu process (optional, should be detected automatically).
 
 Open a command prompt/terminal window and drag the executable into it to automatically get the path.
 
@@ -65,29 +70,35 @@ You can install Splatlogger as a package from PyPI:
 pip install Splatlogger
 ```
 
-The run with:
+To enable Cemu support, install with the `cemu` extra:
 ```
-splatlogger --ip IP [options]
+pip install "Splatlogger[cemu]"
 ```
-(if that fails, try `python -m splatlogger`) where `IP` is your Wii U's LAN IP address.
+(use `pip install --upgrade` to update from an older version)
 
-To run from source instead, download the latest source archive from the Releases
+Then run with:
+```
+splatlogger --ip IP [options] / --cemu [PID] [options]
+```
+(if that fails, try `python -m splatlogger`)
+
+Use the `--ip` target where `IP` is your Wii U's LAN IP address,
+or the `-c` / `--cemu` target to enable Cemu mode where `PID` is the process ID of the Cemu process (optional, should be detected automatically).
+
+To run from source instead, download the latest source archive from the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest)
 page and extract it, then open a terminal window in the extracted directory.
 
 Install the required dependencies:
 ```
-pip install -r requirements.txt
+pip install -r requirements.txt / cemu_requirements.txt
 ```
 
 Then move into the `src` directory and run:
 ```
-python -m splatlogger --ip IP [options]
+python -m splatlogger --ip IP [options] / --cemu [PID] [options]
 ```
 
 ### Options
-- `-c [PID]`, `--cemu [PID]` - Switch to Cemu mode. The `--ip` argument is not required.
-  - `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).
@@ -105,7 +116,7 @@ Also allows you to view information about the lobby/gathering while on the match
   - `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`)
+    (These options don't affect anything if the 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.
@@ -180,7 +191,7 @@ In that case, it's best to run the package from source or use the executable ins
 ## Important notes
 - 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 account server; this can be disabled with `--service none`.
+- Network IDs and Mii names are fetched from the network's account server; this can be disabled with `--service none`.
 
 - Splatlogger does not collect any sensitive information such as account email addresses or IP addresses.
 
@@ -197,6 +208,10 @@ python scripts/build.py [--upx-dir path/to/upx]
 ```
 use `--upx-dir` if you're using UPX to compress the executable.
 
+You can also use `build.bat` on Windows and `build.sh` on Linux to handle everything automatically.
+
+(No builds or build script are provided for macOS as I don't have a Mac to test, and my attempts at virtualizing macOS have been unsuccessful.)
+
 ## Acknowledgments
 - NWPlayer123 for the reference implementation of a TCPGecko library.
 

splatlogger-1.2.2/src/Splatlogger.egg-info/PKG-INFO → splatlogger-1.2.4/README.md

@@ -1,24 +1,3 @@
-Metadata-Version: 2.4
-Name: Splatlogger
-Version: 1.2.2
-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
-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>=0.1.3
-Requires-Dist: requests>=2.28.0
-Requires-Dist: psutil>=5.9.0
-Requires-Dist: pymemoryeditor>=2.0.0
-Requires-Dist: colorama>=0.4.6
-Requires-Dist: clean-text>=0.7.1
-Requires-Dist: prompt_toolkit>=3.0.0
-Dynamic: license-file
-
 # Splatlogger
 A PID Grabber and player/match information logging tool for Splatoon, supporting Wii U and Cemu*.
 
@@ -47,13 +26,14 @@ On Aroma, use [TCPGecko-Plugin](https://github.com/PinkDiamondTeam/TCPGecko-Plug
 
 ## Usage
 ### Running the executable
-Windows and Linux executables are provided on the Releases page.
+Windows and Linux executables are provided on the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest) page.
 
 Run Splatlogger with:
 ```
-path/to/Splatlogger-executable --ip IP [options]
+path/to/Splatlogger-executable --ip IP [options] / --cemu [PID] [options]
 ```
-where `IP` is your Wii U's LAN IP address.
+Use the `--ip` target where `IP` is your Wii U's LAN IP address,
+or the `-c` / `--cemu` target to enable Cemu mode where `PID` is the process ID of the Cemu process (optional, should be detected automatically).
 
 Open a command prompt/terminal window and drag the executable into it to automatically get the path.
 
@@ -65,29 +45,35 @@ You can install Splatlogger as a package from PyPI:
 pip install Splatlogger
 ```
 
-The run with:
+To enable Cemu support, install with the `cemu` extra:
+```
+pip install "Splatlogger[cemu]"
+```
+(use `pip install --upgrade` to update from an older version)
+
+Then run with:
 ```
-splatlogger --ip IP [options]
+splatlogger --ip IP [options] / --cemu [PID] [options]
 ```
-(if that fails, try `python -m splatlogger`) where `IP` is your Wii U's LAN IP address.
+(if that fails, try `python -m splatlogger`)
 
-To run from source instead, download the latest source archive from the Releases
+Use the `--ip` target where `IP` is your Wii U's LAN IP address,
+or the `-c` / `--cemu` target to enable Cemu mode where `PID` is the process ID of the Cemu process (optional, should be detected automatically).
+
+To run from source instead, download the latest source archive from the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest)
 page and extract it, then open a terminal window in the extracted directory.
 
 Install the required dependencies:
 ```
-pip install -r requirements.txt
+pip install -r requirements.txt / cemu_requirements.txt
 ```
 
 Then move into the `src` directory and run:
 ```
-python -m splatlogger --ip IP [options]
+python -m splatlogger --ip IP [options] / --cemu [PID] [options]
 ```
 
 ### Options
-- `-c [PID]`, `--cemu [PID]` - Switch to Cemu mode. The `--ip` argument is not required.
-  - `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).
@@ -105,7 +91,7 @@ Also allows you to view information about the lobby/gathering while on the match
   - `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`)
+    (These options don't affect anything if the 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.
@@ -180,7 +166,7 @@ In that case, it's best to run the package from source or use the executable ins
 ## Important notes
 - 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 account server; this can be disabled with `--service none`.
+- Network IDs and Mii names are fetched from the network's account server; this can be disabled with `--service none`.
 
 - Splatlogger does not collect any sensitive information such as account email addresses or IP addresses.
 
@@ -197,6 +183,10 @@ python scripts/build.py [--upx-dir path/to/upx]
 ```
 use `--upx-dir` if you're using UPX to compress the executable.
 
+You can also use `build.bat` on Windows and `build.sh` on Linux to handle everything automatically.
+
+(No builds or build script are provided for macOS as I don't have a Mac to test, and my attempts at virtualizing macOS have been unsuccessful.)
+
 ## Acknowledgments
 - NWPlayer123 for the reference implementation of a TCPGecko library.
 

{splatlogger-1.2.2 → splatlogger-1.2.4}/pyproject.toml

@@ -1,21 +1,20 @@
 [build-system]
-requires = ["setuptools>=83.0.0"]
+requires = ["setuptools>=77.0.3"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "Splatlogger"
-version = "1.2.2"
+version = "1.2.4"
 authors = [
     { name="Shadow Doggo", email="shadowdoggo@protonmail.com" }
 ]
 description = "PID Grabber and player/match information logging tool for Splatoon"
 readme = "README.md"
-requires-python = ">=3.11"
+requires-python = ">=3.10"
 dependencies = [
+    "tomli>=1.1.0; python_version<'3.11'",
     "userpaths>=0.1.3",
     "requests>=2.28.0",
-    "psutil>=5.9.0",
-    "pymemoryeditor>=2.0.0",
     "colorama>=0.4.6",
     "clean-text>=0.7.1",
     "prompt_toolkit>=3.0.0"
@@ -27,6 +26,15 @@ classifiers = [
 license = "MIT"
 license-files = ["LICENSE"]
 
+[project.optional-dependencies]
+cemu = [
+    "psutil>=5.9.0",
+    "pymemoryeditor>=2.0.0"
+]
+build = [
+    "pyinstaller>=6.6.0"
+]
+
 [project.urls]
 "Source Code" = "https://codeberg.org/ShadowDoggo/Splatlogger"
 

splatlogger-1.2.2/README.md → splatlogger-1.2.4/src/Splatlogger.egg-info/PKG-INFO

@@ -1,3 +1,28 @@
+Metadata-Version: 2.4
+Name: Splatlogger
+Version: 1.2.4
+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
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tomli>=1.1.0; python_version < "3.11"
+Requires-Dist: userpaths>=0.1.3
+Requires-Dist: requests>=2.28.0
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: clean-text>=0.7.1
+Requires-Dist: prompt_toolkit>=3.0.0
+Provides-Extra: cemu
+Requires-Dist: psutil>=5.9.0; extra == "cemu"
+Requires-Dist: pymemoryeditor>=2.0.0; extra == "cemu"
+Provides-Extra: build
+Requires-Dist: pyinstaller>=6.6.0; extra == "build"
+Dynamic: license-file
+
 # Splatlogger
 A PID Grabber and player/match information logging tool for Splatoon, supporting Wii U and Cemu*.
 
@@ -26,13 +51,14 @@ On Aroma, use [TCPGecko-Plugin](https://github.com/PinkDiamondTeam/TCPGecko-Plug
 
 ## Usage
 ### Running the executable
-Windows and Linux executables are provided on the Releases page.
+Windows and Linux executables are provided on the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest) page.
 
 Run Splatlogger with:
 ```
-path/to/Splatlogger-executable --ip IP [options]
+path/to/Splatlogger-executable --ip IP [options] / --cemu [PID] [options]
 ```
-where `IP` is your Wii U's LAN IP address.
+Use the `--ip` target where `IP` is your Wii U's LAN IP address,
+or the `-c` / `--cemu` target to enable Cemu mode where `PID` is the process ID of the Cemu process (optional, should be detected automatically).
 
 Open a command prompt/terminal window and drag the executable into it to automatically get the path.
 
@@ -44,29 +70,35 @@ You can install Splatlogger as a package from PyPI:
 pip install Splatlogger
 ```
 
-The run with:
+To enable Cemu support, install with the `cemu` extra:
+```
+pip install "Splatlogger[cemu]"
+```
+(use `pip install --upgrade` to update from an older version)
+
+Then run with:
 ```
-splatlogger --ip IP [options]
+splatlogger --ip IP [options] / --cemu [PID] [options]
 ```
-(if that fails, try `python -m splatlogger`) where `IP` is your Wii U's LAN IP address.
+(if that fails, try `python -m splatlogger`)
 
-To run from source instead, download the latest source archive from the Releases
+Use the `--ip` target where `IP` is your Wii U's LAN IP address,
+or the `-c` / `--cemu` target to enable Cemu mode where `PID` is the process ID of the Cemu process (optional, should be detected automatically).
+
+To run from source instead, download the latest source archive from the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest)
 page and extract it, then open a terminal window in the extracted directory.
 
 Install the required dependencies:
 ```
-pip install -r requirements.txt
+pip install -r requirements.txt / cemu_requirements.txt
 ```
 
 Then move into the `src` directory and run:
 ```
-python -m splatlogger --ip IP [options]
+python -m splatlogger --ip IP [options] / --cemu [PID] [options]
 ```
 
 ### Options
-- `-c [PID]`, `--cemu [PID]` - Switch to Cemu mode. The `--ip` argument is not required.
-  - `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).
@@ -84,7 +116,7 @@ Also allows you to view information about the lobby/gathering while on the match
   - `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`)
+    (These options don't affect anything if the 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.
@@ -159,7 +191,7 @@ In that case, it's best to run the package from source or use the executable ins
 ## Important notes
 - 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 account server; this can be disabled with `--service none`.
+- Network IDs and Mii names are fetched from the network's account server; this can be disabled with `--service none`.
 
 - Splatlogger does not collect any sensitive information such as account email addresses or IP addresses.
 
@@ -176,6 +208,10 @@ python scripts/build.py [--upx-dir path/to/upx]
 ```
 use `--upx-dir` if you're using UPX to compress the executable.
 
+You can also use `build.bat` on Windows and `build.sh` on Linux to handle everything automatically.
+
+(No builds or build script are provided for macOS as I don't have a Mac to test, and my attempts at virtualizing macOS have been unsuccessful.)
+
 ## Acknowledgments
 - NWPlayer123 for the reference implementation of a TCPGecko library.
 

{splatlogger-1.2.2 → splatlogger-1.2.4}/src/Splatlogger.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ src/splatlogger/__main__.py
 src/splatlogger/cemu_gecko.py
 src/splatlogger/cli.py
 src/splatlogger/enums.py
+src/splatlogger/errors.py
 src/splatlogger/match_logger.py
 src/splatlogger/splatlogger.py
 src/splatlogger/tcpgecko.py

{splatlogger-1.2.2 → splatlogger-1.2.4}/src/Splatlogger.egg-info/requires.txt

@@ -1,7 +1,15 @@
 userpaths>=0.1.3
 requests>=2.28.0
-psutil>=5.9.0
-pymemoryeditor>=2.0.0
 colorama>=0.4.6
 clean-text>=0.7.1
 prompt_toolkit>=3.0.0
+
+[:python_version < "3.11"]
+tomli>=1.1.0
+
+[build]
+pyinstaller>=6.6.0
+
+[cemu]
+psutil>=5.9.0
+pymemoryeditor>=2.0.0

{splatlogger-1.2.2 → splatlogger-1.2.4}/src/splatlogger/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "1.2.2"
+__version__ = "1.2.4"
 __author__ = "Shadow Doggo"

{splatlogger-1.2.2 → splatlogger-1.2.4}/src/splatlogger/cemu_gecko.py

@@ -6,8 +6,11 @@ import struct
 from types import TracebackType
 from typing import Type
 
-import psutil
-from PyMemoryEditor import OpenProcess, ProcessIDNotExistsError  # type: ignore[import-untyped]
+try:
+    import psutil
+    from PyMemoryEditor import OpenProcess, ProcessIDNotExistsError  # type: ignore[import-untyped]
+except ImportError as ex:
+    raise ImportError("psutil and PyMemoryEditor must be installed to use Cemu mode.") from ex
 
 
 class CemuGecko:

{splatlogger-1.2.2 → splatlogger-1.2.4}/src/splatlogger/cli.py

@@ -3,7 +3,6 @@
 import argparse
 import platform
 import sys
-import tomllib
 import webbrowser
 from pathlib import Path
 
@@ -13,9 +12,15 @@ from prompt_toolkit import PromptSession
 from prompt_toolkit.patch_stdout import patch_stdout
 
 from . import utility_functions as uf, __version__
-from .splatlogger import SplatloggerError, command_lobby_info, main
+from .errors import SplatloggerError
+from .splatlogger import command_lobby_info, main
 from .tuples import AppContext, Options
 
+if sys.version_info >= (3, 11):
+    import tomllib
+else:
+    import tomli as tomllib
+
 
 def cli() -> None:
     if platform.system() == "Windows":

splatlogger-1.2.4/src/splatlogger/errors.py

@@ -0,0 +1,2 @@
+class SplatloggerError(Exception):
+    pass

{splatlogger-1.2.2 → splatlogger-1.2.4}/src/splatlogger/splatlogger.py

@@ -1,5 +1,7 @@
 # Splatlogger (c) 2025 Shadow Doggo.
 
+from __future__ import annotations
+
 import binascii
 import ipaddress
 import logging
@@ -8,18 +10,20 @@ import time
 from base64 import b64decode
 from contextlib import contextmanager
 from datetime import datetime
-from typing import Callable, Iterator
+from typing import Callable, Iterator, TYPE_CHECKING
 
 import requests
 import userpaths  # type: ignore[import-untyped]
 
 from . import utility_functions as uf
-from .cemu_gecko import CemuGecko, CemuGeckoError
 from .enums import Offsets, Pointers
 from .match_logger import MatchLogger
 from .tcpgecko import GeckoConnectionFailedError, TCPGecko
 from .tuples import AccountInfo, AppContext, CommonAddresses, Options, PlayerInfo
-from .utility_functions import SplatloggerError
+from .errors import SplatloggerError
+
+if TYPE_CHECKING:
+    from .cemu_gecko import CemuGecko
 
 # Hack to remove the unidecode warning from clean-text
 logging.disable(logging.CRITICAL)
@@ -97,7 +101,7 @@ def command_lobby_info(ctx: AppContext) -> bool:
                     f"\n{'PID':<10} | {'ANID' if ctx.options.service == 'altendo' else 'PNID':<16}\n{'-' * 30}"
                 )
                 for player in players:
-                    print(f"{player[0]} | {player[1]}")
+                    print(f"{player[0]:<10} | {player[1]}")
         else:
             print("\nNo active session.")
     finally:
@@ -123,6 +127,11 @@ def create_match_logger_instance(ctx: AppContext) -> MatchLogger | None:
 
 def create_tcpgecko_instance(options: Options) -> TCPGecko | CemuGecko:
     if options.platform == "cemu":
+        try:
+            from .cemu_gecko import CemuGecko, CemuGeckoError
+        except ImportError as e:
+            raise SplatloggerError(str(e)) from e
+
         try:
             print("Opening Cemu process...")
             return CemuGecko(options.cemu_pid)

{splatlogger-1.2.2 → splatlogger-1.2.4}/src/splatlogger/tuples.py

@@ -6,11 +6,10 @@ import threading
 from dataclasses import dataclass, field
 from typing import NamedTuple, TYPE_CHECKING
 
-from .cemu_gecko import CemuGecko
-from .tcpgecko import TCPGecko
-
 if TYPE_CHECKING:
     from prompt_toolkit import PromptSession
+    from .cemu_gecko import CemuGecko
+    from .tcpgecko import TCPGecko
 
 
 class Options(NamedTuple):

{splatlogger-1.2.2 → splatlogger-1.2.4}/src/splatlogger/utility_functions.py

@@ -14,6 +14,7 @@ import requests
 from colorama import Fore, Style
 
 from .enums import Offsets
+from .errors import SplatloggerError
 from .tcpgecko import GeckoConnectionClosedError, GeckoReadMemError, TCPGeckoError
 from .tuples import AccountInfo, PlayerInfo
 
@@ -139,7 +140,3 @@ def get_utc_offset(date: datetime) -> int:
         return 0
 
     return round(offset.total_seconds() / 3600)
-
-
-class SplatloggerError(Exception):
-    pass