Launcher folder

Author: glomatico

README.md

@@ -8,12 +8,22 @@ A cross-platform CLI launcher for Toontown Rewritten written in Python and insta
     pip install gttrl
     ```
 3. Run on the command line:
+    ```
+    gttrl
+    ```
+    or specify your account credentials using arguments:
     ```
     gttrl -u username -p password
     ```
 
-## Account file
-The account file is a text file with the following format:
+## Launcher folder
+Once you run the launcher, a folder will be created at `<user home directory>/.gttrl` to store the configuration file and the game files.
+
+## Configuration
+You can configure the launcher by editing the `config.json` file in the launcher folder.
+
+## Auto login
+To enable auto login, create a file named `account.txt` in the launcher folder and put your account credentials in it, separated by a newline:
 ```
 username
 password
@@ -22,29 +32,28 @@ password
 ## Usage
 ```
 usage: gttrl [-h] [-u USERNAME] [-p PASSWORD] [-a ACCOUNT_FILE]
-                   [-f GAME_PATH] [-c PLAY_COOKIE] [-g GAME_SERVER] [-s] [-k]
+                   [-m GAME_PATH] [-c PLAY_COOKIE] [-g GAME_SERVER] [-s] [-k]
                    [-e] [-v]
 
 Glomatico's Toontown Rewritten Launcher
 
 options:
   -h, --help            show this help message and exit
   -u USERNAME, --username USERNAME
-                        Account username (default: None)
+                        Account username
   -p PASSWORD, --password PASSWORD
-                        Account password (default: None)
+                        Account password
   -a ACCOUNT_FILE, --account-file ACCOUNT_FILE
-                        Account file location (default: ./account.txt)
-  -f GAME_PATH, --game-path GAME_PATH
-                        Game path (default: ./Toontown Rewritten)
+                        Account file location
+  -m GAME_PATH, --game-path GAME_PATH
+                        Game path
   -c PLAY_COOKIE, --play-cookie PLAY_COOKIE
-                        Play cookie (default: None)
+                        Play cookie
   -g GAME_SERVER, --game-server GAME_SERVER
-                        Game server (default: None)
-  -s, --skip-update     Skip game update (default: False)
+                        Game server
+  -s, --skip-update     Skip game update
   -k, --print-play-cookie
-                        Print play cookie and game server and exit (default:
-                        False)
-  -e, --enable-log      Enable log (default: False)
+                        Print play cookie and game server and exit
+  -e, --enable-log      Enable logging to the console
   -v, --version         show program's version number and exit
 ```

gttrl/__init__.py

@@ -1,15 +1,15 @@
 import argparse
+import getpass
 from pathlib import Path
 
-from .gttrl import Gttrl
+from .gttrl import Config, Gttrl
 
-__version__ = "1.0"
+__version__ = "1.1"
 
 
 def main():
     parser = argparse.ArgumentParser(
         description="Glomatico's Toontown Rewritten Launcher",
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     parser.add_argument(
         "-u",
@@ -24,13 +24,11 @@ def main():
     parser.add_argument(
         "-a",
         "--account-file",
-        default="./account.txt",
         help="Account file location",
     )
     parser.add_argument(
-        "-f",
+        "-m",
         "--game-path",
-        default="./Toontown Rewritten",
         help="Game path",
     )
     parser.add_argument(
@@ -59,7 +57,7 @@ def main():
         "-e",
         "--enable-log",
         action="store_true",
-        help="Enable log",
+        help="Enable logging to the console",
     )
     parser.add_argument(
         "-v",
@@ -68,15 +66,18 @@ def main():
         version=f"%(prog)s {__version__}",
     )
     args = parser.parse_args()
+    config = Config()
+    config.create_if_not_exists()
+    config_file = config.read_config_file()
     username = args.username
     password = args.password
-    account_file = args.account_file
-    game_path = args.game_path
+    account_file = args.account_file or config_file["account_file"]
+    game_path = args.game_path or config_file["game_path"]
     play_cookie = args.play_cookie
     game_server = args.game_server
-    skip_update = args.skip_update
+    skip_update = args.skip_update or config_file["skip_update"]
     print_play_cookie = args.print_play_cookie
-    enable_log = args.enable_log
+    enable_log = args.enable_log or config_file["enable_log"]
     if (username and not password) or (password and not username):
         raise Exception("Username and password must be provided together")
     elif (play_cookie and not game_server) or (game_server and not play_cookie):
@@ -86,9 +87,8 @@ def main():
             with open(account_file, "r") as file:
                 username, password = file.read().splitlines()
         elif not username and not play_cookie:
-            raise Exception(
-                "Account file does not exist and no others forms of authentication were provided"
-            )
+            username = input("Username: ")
+            password = getpass.getpass("Password: ")
     gttrl = Gttrl(username, password, game_path, enable_log)
     if username:
         print("Logging in...")

gttrl/gttrl.py

@@ -1,5 +1,6 @@
 import bz2
 import hashlib
+import json
 import os
 import platform
 import subprocess
@@ -73,10 +74,11 @@ def get_file_sha1(self, file_location: Path):
         return hasher.hexdigest()
 
     def download_game_files(self):
+        if not self.game_path.exists():
+            self.game_path.mkdir(parents=True, exist_ok=True)
         manifest = self.session.get(
             "https://cdn.toontownrewritten.com/content/patchmanifest.txt"
         ).json()
-        self.game_path.mkdir(parents=True, exist_ok=True)
         keys = list(manifest.keys())
         for key in keys:
             if self.os not in manifest[key]["only"]:
@@ -161,9 +163,36 @@ def launch_game(self, play_cookie, game_server):
                 creationflags=subprocess.CREATE_NO_WINDOW,
             )
         else:
-            os.chmod(self.game_exe, 0o755)
+            if not os.access(self.game_exe, os.X_OK):
+                os.chmod(self.game_exe, 0o755)
             subprocess.Popen(
                 [self.game_exe],
                 stdout=subprocess.DEVNULL,
                 stderr=subprocess.DEVNULL,
             )
+
+
+class Config:
+    def __init__(self):
+        self.config_path = Path.home() / ".gttrl"
+        self.config_location = self.config_path / "config.json"
+
+    def create_if_not_exists(self):
+        if not self.config_path.exists():
+            self.config_path.mkdir(parents=True, exist_ok=True)
+        if not self.config_location.exists():
+            with open(self.config_location, "w") as f:
+                json.dump(
+                    {
+                        "game_path": str(self.config_path / "Toontown Rewritten"),
+                        "skip_update": False,
+                        "enable_log": False,
+                        "account_file": str(self.config_path / "account.txt"),
+                    },
+                    f,
+                    indent=4,
+                )
+
+    def read_config_file(self):
+        with open(self.config_location, "r") as f:
+            return json.load(f)