Splatlogger 1.6.2.post1__tar.gz → 1.6.4__tar.gz

splatlogger-1.6.4/MANIFEST.in

@@ -0,0 +1 @@
+include src/splatlogger/data/*.json

{splatlogger-1.6.2.post1 → splatlogger-1.6.4}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.6.2.post1
-Summary: A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon.
+Version: 1.6.4
+Summary: PID (Principal ID)/Network ID grabber and match logger for Splatoon
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
 Project-URL: Source Code, https://codeberg.org/ShadowDoggo/Splatlogger
@@ -13,18 +13,15 @@ Requires-Dist: userpaths
 Requires-Dist: requests
 Requires-Dist: psutil
 Requires-Dist: pymemoryeditor
+Requires-Dist: colorama
 
 # 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.
+A CLI PID (Principal ID)/Network ID grabber and match logger for Splatoon, written in Python.
 
 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,
+## Prerequisites (Wii U)
+Your console will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew,
 such as Haxchi or the browser exploit.
 
 On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko), [Geckiine](https://hb-app.store/wiiu/geckiine),
@@ -33,27 +30,33 @@ or any other app with the TCPGecko server.
 On Aroma, install the [TCPGecko Aroma plugin](https://codeberg.org/ShadowDoggo/TCPGeckoAroma).
 
 ## Installation
+### Windows executable
 On Windows, you can use the executable provided on the releases page.
-Though if you already have Python installed, it's recommended to use the package.
+Though if you already have Python installed, it's recommended to use the package instead.
+
+### Python package
+To use the package, you'll need to have Python 3.11 or newer installed on your system.
+On Android devices you can use Termux.
 
-To install the package from PyPI, run:
+Install the package from PyPI:
 ```
 pip install Splatlogger
 ```
+(To upgrade from an older version, use `pip install --upgrade`)
 
 Or download the latest release from Codeberg and run:
 ```
 pip install path/to/Splatlogger-v1.x.zip
 ```
 
-If you do have Python installed but do not wish to install the package, you can run the module directly from the source code.
+If you do have Python installed but do not wish to install the package, you can run it from the source code.
 
 Install the required dependencies:
 ```
 cd path/to/Splatlogger-v1.x/ && pip install -r requirements.txt
 ```
 
-Then run the module:
+Then run:
 ```
 cd src/ && python -m splatlogger
 ```
@@ -72,6 +75,12 @@ path/to/Splatlogger-1.x.exe -ip IP [options]
 ```
 
 Options:
+- `-aroma` - Switch to Aroma mode. Enable if using the TCPGecko Aroma plugin.
+
+- `-cemu [PID]` - Switch to Cemu mode. The `-ip` argument is not required.
+  Note: If you have ptrace protection enabled, you'll need to run Python as root. It's best to run the package from source in that case.
+  - `PID` - PID 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).
@@ -82,19 +91,20 @@ Options:
   - `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.
-  Note: If you have ptrace protection enabled, you'll need to run python as root. It's best to run the module from source in that case.
-  - `PID` - PID of the Cemu process (optional).
-
 - `-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.
 
   <img src="stack.png" width="600" alt="(example)">
 
+- `-spfn` - Fetch SFID instead of PNID. Enable if playing on SPFN.
+
+- `-no-pnid` - Disable fetching PNIDs.
+
 - `-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).
+
 Logs are saved in `(User)/Documents/Splatlogger/logs/`.
 
 To always run with the same IP and options without having to type them in manually, create an `args.txt` file in
@@ -104,6 +114,8 @@ 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](https://github.com/wiiudev/pyGecko) authors for most of `tcpgecko.py`.
+- [pyGecko](https://github.com/wiiudev/pyGecko) authors for the reference implementation of a Python TCPGecko library.
 
 - Everyone who contributed to [PNIDGrab](https://github.com/JerrySM64/PNIDGrab) and other similar PID grabbers as those were used as a reference.
+
+- Special thanks to Pirlo for helping me with certain stuff.

{splatlogger-1.6.2.post1 → splatlogger-1.6.4}/README.md

@@ -1,14 +1,10 @@
 # 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.
+A CLI PID (Principal ID)/Network ID grabber and match logger for Splatoon, written in Python.
 
 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,
+## Prerequisites (Wii U)
+Your console will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew,
 such as Haxchi or the browser exploit.
 
 On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko), [Geckiine](https://hb-app.store/wiiu/geckiine),
@@ -17,27 +13,33 @@ or any other app with the TCPGecko server.
 On Aroma, install the [TCPGecko Aroma plugin](https://codeberg.org/ShadowDoggo/TCPGeckoAroma).
 
 ## Installation
+### Windows executable
 On Windows, you can use the executable provided on the releases page.
-Though if you already have Python installed, it's recommended to use the package.
+Though if you already have Python installed, it's recommended to use the package instead.
+
+### Python package
+To use the package, you'll need to have Python 3.11 or newer installed on your system.
+On Android devices you can use Termux.
 
-To install the package from PyPI, run:
+Install the package from PyPI:
 ```
 pip install Splatlogger
 ```
+(To upgrade from an older version, use `pip install --upgrade`)
 
 Or download the latest release from Codeberg and run:
 ```
 pip install path/to/Splatlogger-v1.x.zip
 ```
 
-If you do have Python installed but do not wish to install the package, you can run the module directly from the source code.
+If you do have Python installed but do not wish to install the package, you can run it from the source code.
 
 Install the required dependencies:
 ```
 cd path/to/Splatlogger-v1.x/ && pip install -r requirements.txt
 ```
 
-Then run the module:
+Then run:
 ```
 cd src/ && python -m splatlogger
 ```
@@ -56,6 +58,12 @@ path/to/Splatlogger-1.x.exe -ip IP [options]
 ```
 
 Options:
+- `-aroma` - Switch to Aroma mode. Enable if using the TCPGecko Aroma plugin.
+
+- `-cemu [PID]` - Switch to Cemu mode. The `-ip` argument is not required.
+  Note: If you have ptrace protection enabled, you'll need to run Python as root. It's best to run the package from source in that case.
+  - `PID` - PID 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).
@@ -66,19 +74,20 @@ Options:
   - `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.
-  Note: If you have ptrace protection enabled, you'll need to run python as root. It's best to run the module from source in that case.
-  - `PID` - PID of the Cemu process (optional).
-
 - `-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.
 
   <img src="stack.png" width="600" alt="(example)">
 
+- `-spfn` - Fetch SFID instead of PNID. Enable if playing on SPFN.
+
+- `-no-pnid` - Disable fetching PNIDs.
+
 - `-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).
+
 Logs are saved in `(User)/Documents/Splatlogger/logs/`.
 
 To always run with the same IP and options without having to type them in manually, create an `args.txt` file in
@@ -88,6 +97,8 @@ 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](https://github.com/wiiudev/pyGecko) authors for most of `tcpgecko.py`.
+- [pyGecko](https://github.com/wiiudev/pyGecko) authors for the reference implementation of a Python TCPGecko library.
 
 - Everyone who contributed to [PNIDGrab](https://github.com/JerrySM64/PNIDGrab) and other similar PID grabbers as those were used as a reference.
+
+- Special thanks to Pirlo for helping me with certain stuff.

{splatlogger-1.6.2.post1 → splatlogger-1.6.4}/pyproject.toml

@@ -4,18 +4,19 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "Splatlogger"
-version = "1.6.2.post1"
+version = "1.6.4"
 authors = [
     { name="Shadow Doggo", email="shadowdoggo@protonmail.com" }
 ]
-description = "A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon."
+description = "PID (Principal ID)/Network ID grabber and match logger for Splatoon"
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
     "userpaths",
     "requests",
     "psutil",
-    "pymemoryeditor"
+    "pymemoryeditor",
+    "colorama"
 ]
 classifiers = [
     "Programming Language :: Python :: 3",

{splatlogger-1.6.2.post1 → splatlogger-1.6.4}/src/Splatlogger.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.6.2.post1
-Summary: A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon.
+Version: 1.6.4
+Summary: PID (Principal ID)/Network ID grabber and match logger for Splatoon
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
 Project-URL: Source Code, https://codeberg.org/ShadowDoggo/Splatlogger
@@ -13,18 +13,15 @@ Requires-Dist: userpaths
 Requires-Dist: requests
 Requires-Dist: psutil
 Requires-Dist: pymemoryeditor
+Requires-Dist: colorama
 
 # 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.
+A CLI PID (Principal ID)/Network ID grabber and match logger for Splatoon, written in Python.
 
 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,
+## Prerequisites (Wii U)
+Your console will need to have either the Tiramisu or Aroma environment set up or have another way to run homebrew,
 such as Haxchi or the browser exploit.
 
 On Tiramisu, use [TCPGecko](https://github.com/BullyWiiPlaza/tcpgecko), [Geckiine](https://hb-app.store/wiiu/geckiine),
@@ -33,27 +30,33 @@ or any other app with the TCPGecko server.
 On Aroma, install the [TCPGecko Aroma plugin](https://codeberg.org/ShadowDoggo/TCPGeckoAroma).
 
 ## Installation
+### Windows executable
 On Windows, you can use the executable provided on the releases page.
-Though if you already have Python installed, it's recommended to use the package.
+Though if you already have Python installed, it's recommended to use the package instead.
+
+### Python package
+To use the package, you'll need to have Python 3.11 or newer installed on your system.
+On Android devices you can use Termux.
 
-To install the package from PyPI, run:
+Install the package from PyPI:
 ```
 pip install Splatlogger
 ```
+(To upgrade from an older version, use `pip install --upgrade`)
 
 Or download the latest release from Codeberg and run:
 ```
 pip install path/to/Splatlogger-v1.x.zip
 ```
 
-If you do have Python installed but do not wish to install the package, you can run the module directly from the source code.
+If you do have Python installed but do not wish to install the package, you can run it from the source code.
 
 Install the required dependencies:
 ```
 cd path/to/Splatlogger-v1.x/ && pip install -r requirements.txt
 ```
 
-Then run the module:
+Then run:
 ```
 cd src/ && python -m splatlogger
 ```
@@ -72,6 +75,12 @@ path/to/Splatlogger-1.x.exe -ip IP [options]
 ```
 
 Options:
+- `-aroma` - Switch to Aroma mode. Enable if using the TCPGecko Aroma plugin.
+
+- `-cemu [PID]` - Switch to Cemu mode. The `-ip` argument is not required.
+  Note: If you have ptrace protection enabled, you'll need to run Python as root. It's best to run the package from source in that case.
+  - `PID` - PID 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).
@@ -82,19 +91,20 @@ Options:
   - `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.
-  Note: If you have ptrace protection enabled, you'll need to run python as root. It's best to run the module from source in that case.
-  - `PID` - PID of the Cemu process (optional).
-
 - `-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.
 
   <img src="stack.png" width="600" alt="(example)">
 
+- `-spfn` - Fetch SFID instead of PNID. Enable if playing on SPFN.
+
+- `-no-pnid` - Disable fetching PNIDs.
+
 - `-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).
+
 Logs are saved in `(User)/Documents/Splatlogger/logs/`.
 
 To always run with the same IP and options without having to type them in manually, create an `args.txt` file in
@@ -104,6 +114,8 @@ 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](https://github.com/wiiudev/pyGecko) authors for most of `tcpgecko.py`.
+- [pyGecko](https://github.com/wiiudev/pyGecko) authors for the reference implementation of a Python TCPGecko library.
 
 - Everyone who contributed to [PNIDGrab](https://github.com/JerrySM64/PNIDGrab) and other similar PID grabbers as those were used as a reference.
+
+- Special thanks to Pirlo for helping me with certain stuff.

{splatlogger-1.6.2.post1 → splatlogger-1.6.4}/src/Splatlogger.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+MANIFEST.in
 README.md
 pyproject.toml
 src/Splatlogger.egg-info/PKG-INFO
@@ -9,7 +10,11 @@ src/Splatlogger.egg-info/top_level.txt
 src/splatlogger/__init__.py
 src/splatlogger/__main__.py
 src/splatlogger/cemu_gecko.py
-src/splatlogger/data.py
+src/splatlogger/enums.py
 src/splatlogger/match_logger.py
 src/splatlogger/tcpgecko.py
-src/splatlogger/tcpgecko_aroma.py
+src/splatlogger/tcpgecko_aroma.py
+src/splatlogger/tuples.py
+src/splatlogger/utility_functions.py
+src/splatlogger/data/api.json
+src/splatlogger/data/names.json

{splatlogger-1.6.2.post1 → splatlogger-1.6.4}/src/Splatlogger.egg-info/requires.txt

@@ -2,3 +2,4 @@ userpaths
 requests
 psutil
 pymemoryeditor
+colorama