Splatlogger 1.6.1__tar.gz → 1.6.2__tar.gz

{splatlogger-1.6.1 → splatlogger-1.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.6.1
+Version: 1.6.2
 Summary: A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon.
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
@@ -38,12 +38,12 @@ Though if you already have Python installed, it's recommended to use the package
 
 To install the package from PyPI, run:
 ```
-python -m pip install Splatlogger
+pip install Splatlogger
 ```
 
 Or download the latest release from Codeberg and run:
 ```
-python -m pip install path/to/Splatlogger-v1.x.zip
+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.
@@ -78,26 +78,27 @@ Options:
   - `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`).
+- `-auto [option]` - Enable auto logging. When enabled will automatically log every match you play. The 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.
 
 - `-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) Beginning address of the stack space for Default Core 1 (Debug > View PPC threads).
-Reuired for logging stats, not needed otherwise.
+- `-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)">
 
 - `-silent` - Disable printing logs to the console.
 
-Logs are saved in `/[User]/Documents/Splatlogger/logs/[Date]`.
+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.
+`(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.

{splatlogger-1.6.1 → splatlogger-1.6.2}/README.md

@@ -22,12 +22,12 @@ Though if you already have Python installed, it's recommended to use the package
 
 To install the package from PyPI, run:
 ```
-python -m pip install Splatlogger
+pip install Splatlogger
 ```
 
 Or download the latest release from Codeberg and run:
 ```
-python -m pip install path/to/Splatlogger-v1.x.zip
+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.
@@ -62,26 +62,27 @@ Options:
   - `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`).
+- `-auto [option]` - Enable auto logging. When enabled will automatically log every match you play. The 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.
 
 - `-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) Beginning address of the stack space for Default Core 1 (Debug > View PPC threads).
-Reuired for logging stats, not needed otherwise.
+- `-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)">
 
 - `-silent` - Disable printing logs to the console.
 
-Logs are saved in `/[User]/Documents/Splatlogger/logs/[Date]`.
+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.
+`(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.

{splatlogger-1.6.1 → splatlogger-1.6.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "Splatlogger"
-version = "1.6.1"
+version = "1.6.2"
 authors = [
     { name="Shadow Doggo", email="shadowdoggo@protonmail.com" }
 ]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.6.1
+Version: 1.6.2
 Summary: A CLI PID (Principal ID)/PNID grabber and match logger for Splatoon.
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
@@ -38,12 +38,12 @@ Though if you already have Python installed, it's recommended to use the package
 
 To install the package from PyPI, run:
 ```
-python -m pip install Splatlogger
+pip install Splatlogger
 ```
 
 Or download the latest release from Codeberg and run:
 ```
-python -m pip install path/to/Splatlogger-v1.x.zip
+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.
@@ -78,26 +78,27 @@ Options:
   - `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`).
+- `-auto [option]` - Enable auto logging. When enabled will automatically log every match you play. The 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.
 
 - `-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) Beginning address of the stack space for Default Core 1 (Debug > View PPC threads).
-Reuired for logging stats, not needed otherwise.
+- `-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)">
 
 - `-silent` - Disable printing logs to the console.
 
-Logs are saved in `/[User]/Documents/Splatlogger/logs/[Date]`.
+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.
+`(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.

{splatlogger-1.6.1 → splatlogger-1.6.2}/src/splatlogger/__main__.py

@@ -19,7 +19,7 @@ from .match_logger import MatchLogger
 from .tcpgecko import TCPGecko, TCPGeckoException
 from .tcpgecko_aroma import TCPGeckoAroma
 
-_VERSION = "1.6.1"
+_VERSION = "1.6.2"
 
 
 class Options(NamedTuple):
@@ -58,8 +58,8 @@ def main() -> None:
                         metavar="Address (in hex)")
     parser.add_argument("-silent", help="Disable printing logs to the console.", action="store_true")
 
-    if os.path.isfile(f"{userpaths.get_my_documents()}/Splatlogger/args.txt"):
-        with open(f"{userpaths.get_my_documents()}/Splatlogger/args.txt", encoding="utf-8") as f:
+    if os.path.isfile(os.path.join(userpaths.get_my_documents(), "Splatlogger/args.txt")):
+        with open((os.path.join(userpaths.get_my_documents(), "Splatlogger/args.txt")), encoding="utf-8") as f:
             args = parser.parse_args(f.read().split())
     else:
         args = parser.parse_args()
@@ -67,7 +67,7 @@ def main() -> None:
     if len(sys.argv) == 1:
         print('No arguments were provided. Run "splatlogger -h" for help.')
         print("Would you like to open the README? (y/n)")
-        if input().lower() == "y":
+        if input().lower() in ("y", "yes"):
             webbrowser.open("https://codeberg.org/ShadowDoggo/Splatlogger/src/branch/main/README.md")
 
         sys.exit()
@@ -96,9 +96,6 @@ def main() -> None:
     gecko: TCPGecko | TCPGeckoAroma | CemuGecko
     if args.cemu:
         ptr_offset = 0x503000
-        if args.log_level == "stats" and not args.stack:
-            print("Stack space address must be specified for stats logging on Cemu (see README).")
-            sys.exit()
         try:
             print("Opening Cemu process...")
             gecko = CemuGecko(int(args.cemu))
@@ -129,7 +126,7 @@ def main() -> None:
             print(f"\nAn error has occurred: {e}\nRetrying in 10 seconds...")
             time.sleep(10)
         except AssertionError:
-            print("\nUnable to find StaticMem and PlayerInfoAry address.\nRetrying in 10 seconds...")
+            print("\nCould not find StaticMem and PlayerInfoAry address.\nRetrying in 10 seconds...")
             time.sleep(10)
     else:
         print("\nFailed after 3 tries.")

{splatlogger-1.6.1 → splatlogger-1.6.2}/src/splatlogger/cemu_gecko.py

@@ -22,7 +22,7 @@ class CemuGecko:
 
         self._base_address = self._get_base_address()
         if self._base_address == 0:
-            raise CemuGeckoException("Could not find Wii U memory space base address.")
+            raise CemuGeckoException("Could not find Cemu's Wii U memory space.")
 
     def peek_raw(self, address: int, length: int) -> bytes:
         """Read raw memory starting at address and ending at address + length.
@@ -50,13 +50,17 @@ class CemuGecko:
         return self.peek_raw(address, length).decode(encoding)
 
     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.
+        # I'm pretty sure winterberry found the method for this, so credit goes to him.
         base_address = 0
         for memory_region in self._process.get_memory_regions():
             address = memory_region["address"]
             size = memory_region["size"]
             if size == 0x4E000000:
-                base_address = address - 0x2000000
-                break
+                pattern = bytes.fromhex("02D4E7")
+                if self._process.read_process_memory(address + 0xE000000, bytes, bufflength=20).find(pattern) != -1:
+                    base_address = address - 0x2000000
+                    break
 
         return base_address
 

{splatlogger-1.6.1 → splatlogger-1.6.2}/src/splatlogger/match_logger.py

@@ -1,6 +1,7 @@
 # Splatlogger (c) 2025 Shadow Doggo.
 
 import os
+import platform
 import time
 from datetime import datetime
 
@@ -16,7 +17,7 @@ class MatchLogger:
     def __init__(self, gecko: TCPGecko | CemuGecko, log_level: str, auto_logging: bool, aroma: bool,
                  cemu: bool, stack: int | None, static_mem_adr: int) -> None:
         self._gecko = gecko
-        self._log_path = userpaths.get_my_documents() + "/Splatlogger/logs"
+        self._log_path = os.path.join(userpaths.get_my_documents(), "Splatlogger/logs")
         self._log_level = log_level
         self._auto_logging = auto_logging
         self._static_mem_adr = static_mem_adr
@@ -135,9 +136,14 @@ class MatchLogger:
         ptr_offset = 0
         if self._cemu:
             ptr_offset = 0x503000
-            if isinstance(self._stack, int):
+            if self._stack:
                 stats_adr = self._stack + Offsets.CEMU_STATS
                 win_team_adr = self._stack + Offsets.CEMU_WIN_TEAM
+            else:
+                # Assume default values if stack is not provided. These seem consistent across various systems.
+                stack = 0xE101440 if platform.system() == "Windows" else 0xE175900
+                stats_adr = stack + Offsets.CEMU_STATS
+                win_team_adr = stack + Offsets.CEMU_WIN_TEAM
 
         if self._aroma:
             stats_adr -= 0x30

{splatlogger-1.6.1 → splatlogger-1.6.2}/src/splatlogger/tcpgecko.py

@@ -86,7 +86,7 @@ class TCPGecko:
         if status == b"\xb0":
             return b"\x00" * length
 
-        raise TCPGeckoException("Unable to read memory.")
+        raise TCPGeckoException("Failed to read memory.")
 
     @staticmethod
     def _valid_range(address: int, length: int) -> bool: