| Name | gttrl JSON |
| Version |
1.4
JSON |
| download |
| home_page | None |
| Summary | A cross-platform CLI launcher for Toontown Rewritten. |
| upload_time | 2024-06-16 05:16:00 |
| maintainer | None |
| docs_url | None |
| author | glomatico |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
click
requests
tqdm
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```bash
pip install gttrl
```
## Usage
```bash
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "gttrl",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "glomatico",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1a/14/3cc886ea25963aed7f40d291bad3c17cb0cb904616671b3c68fa827fe544/gttrl-1.4.tar.gz",
"platform": null,
"description": "# Glomatico's Toontown Rewritten Launcher\nA cross-platform CLI launcher for Toontown Rewritten.\n \n## Features\n* Cross-platform\n* Lightweight and fast\n* Easy to install and use\n* Highly configurable\n \n## Prerequisites\n* Python 3.8 or higher\n \n## Installation\n1. Install the package `gttrl` using pip\n ```bash\n pip install gttrl\n ```\n\n## Usage\n```bash\ngttrl [OPTIONS]\n```\ngttrl 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.\n\n## Configuration\ngttrl can be configured by using the command line arguments or the config file.\n\nThe 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.\n\nConfig file values can be overridden using command line arguments.\n\n| Command line argument / Config file key | Description | Default value |\n| --------------------------------------------------------------------------- | ------------------------------------------- | --------------------------- |\n| `--username`, `-u` / - | Username. | `null` |\n| `--password`, `-p` / - | Password. | `null` |\n| `--play-cookie` / - | Play cookie. | `null` |\n| `--game-server` / - | Game server. | `null` |\n| `--login-mode` / `login_mode` | Login mode. | `credentials` |\n| `--print-play-cookie-and-game-server` / `print_play_cookie_and_game_server` | Print play cookie and game server and exit. | `false` |\n| `--skip-update` / `skip_update` | Skip checking for game updates. | `false` |\n| `--config-path` / - | Path to the config file. | `<home>/.gttrl/config.json` |\n| `--game-dir-path` / `game_dir_path` | Path to the game directory. | `<home>/.gttrl/game` |\n| `--display-game-log` / `display_game_log` | Display game log on terminal. | `false` |\n| `--no-config-file`, `-n` / - | Don't load the config file. | `false` |\n\n### Login modes\nThe following login modes are available:\n* `credentials`\n * Manually enter your account credentials or read from the command line arguments.\n* `playcookieandgameserver`\n * 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.\n",
"bugtrack_url": null,
"license": null,
"summary": "A cross-platform CLI launcher for Toontown Rewritten.",
"version": "1.4",
"project_urls": {
"homepage": "https://github.com/glomatico/gttrl",
"repository": "https://github.com/glomatico/gttrl"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c54d6a82f65e0e9029ed5393b3d0a19a19771e2f0df9b6bef04484ae27e024e3",
"md5": "b9f0defc98f76b726534d163fc9f0545",
"sha256": "01468c5ba9438880b0f9c94896d1e2168267bda665ee5243d3584d6978bde16d"
},
"downloads": -1,
"filename": "gttrl-1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9f0defc98f76b726534d163fc9f0545",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6771,
"upload_time": "2024-06-16T05:15:57",
"upload_time_iso_8601": "2024-06-16T05:15:57.162417Z",
"url": "https://files.pythonhosted.org/packages/c5/4d/6a82f65e0e9029ed5393b3d0a19a19771e2f0df9b6bef04484ae27e024e3/gttrl-1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1a143cc886ea25963aed7f40d291bad3c17cb0cb904616671b3c68fa827fe544",
"md5": "6da8a867bf642eaf56381a21e709e30e",
"sha256": "870241e0a19c3141a34ac6dbf40f16478ee31bb9cbed7f6d83449839ab5ab66f"
},
"downloads": -1,
"filename": "gttrl-1.4.tar.gz",
"has_sig": false,
"md5_digest": "6da8a867bf642eaf56381a21e709e30e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6380,
"upload_time": "2024-06-16T05:16:00",
"upload_time_iso_8601": "2024-06-16T05:16:00.158036Z",
"url": "https://files.pythonhosted.org/packages/1a/14/3cc886ea25963aed7f40d291bad3c17cb0cb904616671b3c68fa827fe544/gttrl-1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-16 05:16:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "glomatico",
"github_project": "gttrl",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "tqdm",
"specs": []
}
],
"lcname": "gttrl"
}
