Splatlogger 1.3.0__tar.gz → 1.3.1__tar.gz

{splatlogger-1.3.0/src/Splatlogger.egg-info → splatlogger-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.3.0
+Version: 1.3.1
 Summary: PID Grabber and player/match information logging tool for Splatoon
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
@@ -50,8 +50,13 @@ or any other app with the TCPGecko server.
 On Aroma, use [TCPGecko-Plugin](https://github.com/PinkDiamondTeam/TCPGecko-Plugin).
 
 ## Usage
+Splatlogger uses a command-line interface (CLI), you will need to run it within a terminal.
+
+On Windows, it's best to use [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install)
+or [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/install-powershell-on-windows), as the Command Prompt can't properly display certain characters.
+
 ### Running the executable
-Windows and Linux executables are provided on the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest) page.
+Executables for Windows, Linux and macOS are provided on the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest) page.
 
 Run Splatlogger with:
 ```
@@ -60,9 +65,9 @@ path/to/Splatlogger-executable --ip IP [options] / --cemu [PID] [options]
 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.
+Drag the executable into the terminal window to automatically get the path.
 
-On Linux, you might need to make the file executable first with `chmod +x path/to/Splatlogger-executable`
+On Linux and macOS, you might need to make the file executable first with `chmod +x path/to/Splatlogger-executable`
 
 ### Running with Python
 You can install Splatlogger as a package from PyPI:
@@ -174,9 +179,6 @@ 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.
 
@@ -200,9 +202,7 @@ 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.)
+You can also use `build.bat` on Windows and `build.sh` on Linux/macOS to handle everything automatically.
 
 ## Acknowledgments
 - NWPlayer123 for the reference implementation of a TCPGecko library.

{splatlogger-1.3.0 → splatlogger-1.3.1}/README.md

@@ -25,8 +25,13 @@ or any other app with the TCPGecko server.
 On Aroma, use [TCPGecko-Plugin](https://github.com/PinkDiamondTeam/TCPGecko-Plugin).
 
 ## Usage
+Splatlogger uses a command-line interface (CLI), you will need to run it within a terminal.
+
+On Windows, it's best to use [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install)
+or [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/install-powershell-on-windows), as the Command Prompt can't properly display certain characters.
+
 ### Running the executable
-Windows and Linux executables are provided on the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest) page.
+Executables for Windows, Linux and macOS are provided on the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest) page.
 
 Run Splatlogger with:
 ```
@@ -35,9 +40,9 @@ path/to/Splatlogger-executable --ip IP [options] / --cemu [PID] [options]
 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.
+Drag the executable into the terminal window to automatically get the path.
 
-On Linux, you might need to make the file executable first with `chmod +x path/to/Splatlogger-executable`
+On Linux and macOS, you might need to make the file executable first with `chmod +x path/to/Splatlogger-executable`
 
 ### Running with Python
 You can install Splatlogger as a package from PyPI:
@@ -149,9 +154,6 @@ 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.
 
@@ -175,9 +177,7 @@ 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.)
+You can also use `build.bat` on Windows and `build.sh` on Linux/macOS to handle everything automatically.
 
 ## Acknowledgments
 - NWPlayer123 for the reference implementation of a TCPGecko library.

{splatlogger-1.3.0 → splatlogger-1.3.1}/pyproject.toml

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

{splatlogger-1.3.0 → splatlogger-1.3.1/src/Splatlogger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Splatlogger
-Version: 1.3.0
+Version: 1.3.1
 Summary: PID Grabber and player/match information logging tool for Splatoon
 Author-email: Shadow Doggo <shadowdoggo@protonmail.com>
 License-Expression: MIT
@@ -50,8 +50,13 @@ or any other app with the TCPGecko server.
 On Aroma, use [TCPGecko-Plugin](https://github.com/PinkDiamondTeam/TCPGecko-Plugin).
 
 ## Usage
+Splatlogger uses a command-line interface (CLI), you will need to run it within a terminal.
+
+On Windows, it's best to use [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install)
+or [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/install-powershell-on-windows), as the Command Prompt can't properly display certain characters.
+
 ### Running the executable
-Windows and Linux executables are provided on the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest) page.
+Executables for Windows, Linux and macOS are provided on the [Releases](https://codeberg.org/ShadowDoggo/Splatlogger/releases/latest) page.
 
 Run Splatlogger with:
 ```
@@ -60,9 +65,9 @@ path/to/Splatlogger-executable --ip IP [options] / --cemu [PID] [options]
 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.
+Drag the executable into the terminal window to automatically get the path.
 
-On Linux, you might need to make the file executable first with `chmod +x path/to/Splatlogger-executable`
+On Linux and macOS, you might need to make the file executable first with `chmod +x path/to/Splatlogger-executable`
 
 ### Running with Python
 You can install Splatlogger as a package from PyPI:
@@ -174,9 +179,6 @@ 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.
 
@@ -200,9 +202,7 @@ 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.)
+You can also use `build.bat` on Windows and `build.sh` on Linux/macOS to handle everything automatically.
 
 ## Acknowledgments
 - NWPlayer123 for the reference implementation of a TCPGecko library.

{splatlogger-1.3.0 → splatlogger-1.3.1}/src/splatlogger/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "1.3.0"
+__version__ = "1.3.1"
 __author__ = "Shadow Doggo"

{splatlogger-1.3.0 → splatlogger-1.3.1}/src/splatlogger/cemu_gecko.py

@@ -74,11 +74,9 @@ class CemuGecko:
     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:

{splatlogger-1.3.0 → splatlogger-1.3.1}/src/splatlogger/match_logger.py

@@ -101,8 +101,11 @@ class MatchLogger:
             if self._ctx.options.log_level == "full" and not disconnect:
                 if (player_stats := stats_by_idx.get(player_info.idx)) is not None:
                     match_log += self._format_stats_log(
-                        player_info, match_results.winning_team if match_results else None,
-                        versus_rule, player_stats, dcd_players
+                        player_info,
+                        match_results.winning_team if match_results else None,
+                        versus_rule,
+                        player_stats,
+                        dcd_players
                     )
 
         if match_results:

{splatlogger-1.3.0 → splatlogger-1.3.1}/src/splatlogger/splatlogger.py

@@ -152,7 +152,7 @@ def create_tcpgecko_instance(options: Options) -> TCPGecko | CemuGecko:
             uf.print_error(str(e))
             continue
 
-    raise SplatloggerError("\nFailed after 2 tries.")
+    raise SplatloggerError("\nFailed after two attempts.")
 
 
 @uf.handle_gecko_errors
@@ -160,10 +160,10 @@ def get_static_mem_adr(gecko: TCPGecko | CemuGecko, options: Options) -> int:
     static_mem_adr = gecko.peek32(Pointers.STATIC_MEM.convert(options.platform))
     if static_mem_adr == 0:
         msg = (
-            "Successfully opened Cemu process but could not read StaticMem address. "
+            "Successfully opened Cemu process but could not read StaticMem address.\n"
             "This is likely caused by ptrace protection (see README)."
             if options.platform == "cemu" else
-            "Connected successfully but could not find StaticMem address. "
+            "Connected successfully but could not find StaticMem address.\n"
             "Please open Splatoon first."
         )
         raise SplatloggerError(msg)
@@ -256,7 +256,7 @@ def get_player_count(ctx: AppContext, main_mgr_base_adr: int) -> int:
             if 1 <= player_count <= 8:
                 return player_count
     else:
-        uf.print_warning("You are currently not in a match. Logging previous match data "
+        uf.print_warning("You are currently not in a match.\nLogging previous match data "
                          "(Player 1 data will be your own, Session ID will be the current one).\n")
 
     return 8
@@ -462,8 +462,14 @@ def get_altendo_account_info(player_pid: int) -> AccountInfo:
 
         try:
             mii_data = b64decode(mii_data_response.text.replace("\\n", "").replace("\\r", ""))
-            mii_name = clean(mii_data[26:46].decode("utf-16", errors="replace").split("\u0000")[0],
-                             to_ascii=False, lower=False, no_line_breaks=True)
+            mii_name = clean(
+                mii_data[26:46]
+                .decode("utf-16", errors="replace")
+                .split("\u0000")[0],
+                to_ascii=False,
+                lower=False,
+                no_line_breaks=True
+            )
         except (binascii.Error, UnicodeDecodeError):
             request_error = "Failed to decode Mii name."
             time.sleep(1)

{splatlogger-1.3.0 → splatlogger-1.3.1}/src/splatlogger/tcpgecko.py

@@ -28,6 +28,8 @@ class TCPGecko:
     """Python library for use with TCPGecko."""
 
     def __init__(self, ip: str, *, port: int = DEFAULT_PORT, timeout: int = DEFAULT_TIMEOUT) -> None:
+        self._address = (ip, port)
+        self._timeout = timeout
         self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP)
         self._socket.settimeout(timeout)
         try:
@@ -50,6 +52,13 @@ class TCPGecko:
         """Close the TCPGecko connection."""
         self._socket.close()
 
+    def reconnect(self) -> None:
+        self.close()
+        try:
+            self._socket = socket.create_connection(self._address, timeout=self._timeout)
+        except OSError as e:
+            raise GeckoConnectionFailedError(f"Reconnection failed: {e}") from e
+
     def peek_raw(self, address: int, length: int) -> bytes:
         """Read raw memory starting at address and ending at address + length.
         Returns a bytes object.

{splatlogger-1.3.0 → splatlogger-1.3.1}/src/splatlogger/utility_functions.py

@@ -14,7 +14,7 @@ import requests
 from colorama import Fore, Style
 
 from .errors import SplatloggerError
-from .tcpgecko import GeckoConnectionClosedError, GeckoReadMemError, TCPGeckoError
+from .tcpgecko import GeckoConnectionClosedError, GeckoReadMemError, TCPGecko, TCPGeckoError
 from .tuples import AccountInfo, PlayerInfo
 
 if TYPE_CHECKING:
@@ -47,34 +47,55 @@ def read_int(data: bytes, offset: int, length: int, *, signed: bool = False) ->
 def handle_gecko_errors(func: Callable[..., Any]) -> Any:
     @wraps(func)
     def wrapper(*args: Any, **kwargs: Any):
-        for _ in range(3):
+        first = args[0] if args else kwargs.get("ctx", kwargs.get("gecko"))
+        gecko = getattr(first, "gecko", first)
+        stop_event = getattr(first, "stop_event", None)
+        reconnect = False
+        last_error = None
+
+        for attempt in range(2):
             try:
+                if reconnect:
+                    gecko.reconnect()
+                    reconnect = False
+
                 return func(*args, **kwargs)
-            except ConnectionResetError:
-                msg = "Connection reset abruptly."
-                break
-            except BrokenPipeError:
-                msg = "Socket operation failed. Connection was closed abruptly."
-                break
-            except GeckoConnectionClosedError:
-                msg = "Connection closed by the server."
-                break
-            except ProcessLookupError:
-                msg = "Cemu process was closed."
-                break
-            except GeckoReadMemError as e:
-                print_warning(f"\nReading memory failed: {e}\nRetrying in 10 seconds...")
-                time.sleep(10)
-            except TimeoutError:
-                print_warning(f"\nSocket operation timed out.\nRetrying in 10 seconds...")
-                time.sleep(10)
-            except (OSError, TCPGeckoError) as e:
-                print_warning(f"\nAn error has occurred: {e}\nRetrying in 10 seconds...")
-                time.sleep(10)
-        else:
-            msg = "Failed after 3 tries."
-
-        raise SplatloggerError(msg)
+            except ProcessLookupError as ex:
+                raise SplatloggerError("Cemu process was closed.") from ex
+            except (OSError, TCPGeckoError) as ex:
+                last_error = ex
+
+                if isinstance(gecko, TCPGecko):
+                    reconnect = True
+                    try:
+                        gecko.close()
+                    except OSError:
+                        pass
+
+                if attempt == 1:
+                    break
+
+                if isinstance(ex, ConnectionResetError):
+                    message = "Connection reset abruptly."
+                elif isinstance(ex, BrokenPipeError):
+                    message = "Socket operation failed. Connection was closed abruptly."
+                elif isinstance(ex, GeckoConnectionClosedError):
+                    message = "Connection closed by the server."
+                elif isinstance(ex, GeckoReadMemError):
+                    message = f"Reading memory failed: {ex}"
+                elif isinstance(ex, TimeoutError):
+                    message = "Socket operation timed out."
+                else:
+                    message = f"An error has occurred: {ex}"
+
+                print_warning(f"\n{message}\nRetrying in 10 seconds... (Use 'q' or Ctrl+C to abort)")
+
+                if stop_event is None:
+                    time.sleep(10)
+                elif stop_event.wait(10):
+                    raise SplatloggerError("Stopped while waiting to retry.") from ex
+
+        raise SplatloggerError("Second attempt failed.") from last_error
 
     return wrapper