Skip to main content

A cross-platform CLI launcher for Toontown Rewritten.

Project description

Glomatico's Toontown Rewritten Launcher

A cross-platform CLI launcher for Toontown Rewritten.

Features

  • Cross-platform
  • Lightweight and fast
  • Easy to install and use
  • Highly configurable

Prerequisites

  • Python 3.8 or higher

Installation

  1. Install the package gttrl using pip
    pip install gttrl
    

Usage

gttrl [OPTIONS]

gttrl will prompt the username and password if they are not provided through the command line arguments. After logging in, it will check for game updates and download them if necessary. Finally, it will launch the game.

Configuration

gttrl can be configured by using the command line arguments or the config file.

The config file is created automatically when you run gamdl for the first time at ~/.gttrl/config.json on Linux and %USERPROFILE%\.gttrl\config.json on Windows.

Config file values can be overridden using command line arguments.

Command line argument / Config file key Description Default value
--username, -u / - Username. null
--password, -p / - Password. null
--play-cookie / - Play cookie. null
--game-server / - Game server. null
--login-mode / login_mode Login mode. credentials
--print-play-cookie-and-game-server / print_play_cookie_and_game_server Print play cookie and game server and exit. false
--skip-update / skip_update Skip checking for game updates. false
--config-path / - Path to the config file. <home>/.gttrl/config.json
--game-dir-path / game_dir_path Path to the game directory. <home>/.gttrl/game
--display-game-log / display_game_log Display game log on terminal. false
--no-config-file, -n / - Don't load the config file. false

Login modes

The following login modes are available:

  • credentials
    • Manually enter your account credentials or read from the command line arguments.
  • playcookieandgameserver
    • Manually enter a play cookie and game server or read from the command line arguments. You grab a play cookie and game server by enabling the print_play_cookie_and_server option using credentials login mode. This is useful when you want to allow someone else to play without sharing your account credentials.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gttrl-1.4.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

gttrl-1.4-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file gttrl-1.4.tar.gz.

File metadata

  • Download URL: gttrl-1.4.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for gttrl-1.4.tar.gz
Algorithm Hash digest
SHA256 870241e0a19c3141a34ac6dbf40f16478ee31bb9cbed7f6d83449839ab5ab66f
MD5 6da8a867bf642eaf56381a21e709e30e
BLAKE2b-256 1a143cc886ea25963aed7f40d291bad3c17cb0cb904616671b3c68fa827fe544

See more details on using hashes here.

File details

Details for the file gttrl-1.4-py3-none-any.whl.

File metadata

  • Download URL: gttrl-1.4-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for gttrl-1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 01468c5ba9438880b0f9c94896d1e2168267bda665ee5243d3584d6978bde16d
MD5 b9f0defc98f76b726534d163fc9f0545
BLAKE2b-256 c54d6a82f65e0e9029ed5393b3d0a19a19771e2f0df9b6bef04484ae27e024e3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page