Skip to main content

An easier way to manage and launch sessions for Toontown Rewritten.

Project description

Tooner Logo

An easier way to launch sessions and track invasions for Toontown Rewritten.


Last Commit Commit Activity MIT License
Made with Python 3.7


What does it do?

Currently, tooner allows you to communicate with Toontown Rewritten's login API in order to log in and start a session with very few lines of code.

launcher = tooner.ToontownLauncher(directory="...")
launcher.play(username="username", password="password")

If you're crazy, you can even combine these lines into one!

All you have to do is supply the directory of your Toontown Rewritten installation (where the TTREngine is stored) and your login information. On Windows, check your program files directories. On MacOS, this is in your Application Support directory. Eventually, I'd like to make this library automatically find the installation.

The best part is that you can do this to play multiple toons at once.

You are also able to get the latest invasion information.

tracker = tooner.InvasionTracker()
invasions = tracker.invasions

Unfortunately, latest does not mean freshest in this case, as fresh information is pushed to the Toontown Rewritten Invasion API noticeably infrequently.

Why does this exist?

Since I normally play on MacOS, there is no way for me to open multiple sessions of the Toontown Rewritten launcher without doing it from the terminal; this was really annoying to do every time I wanted to multitoon (which is a lot), so I set out to make this easier.

Ultimately, I was successful in making this functionality work the three major operating systems: Windows, MacOS, and, I assume, on Linux (I haven't been able to test this).

How do I get it?

It's easiest to simply install the package via pip using the following command:

pip install tooner

Otherwise, you can close this repository using the command

git clone https://github.com/jakebrehm/tooner.git

and then you can do whatever you want with it!

Future improvements

My two main concerns and top priorities for this package are the following:

  • Automatically finding the directory, or at least try. I imagine users should still be able to supply their own directory if they know the program is installed in a non-default location. This would further (and possibly significantly) simplify the usage of the package, and would allow for a one-line launcher.
  • Adding support for ToonGuard. The only problem is writing it in such a way that makes sense while keeping in mind tooner's two-line launcher paradigm, as it would require the user to enter a code after having run the script.
  • Make invasion functions. Instead of having to make a class and keep track of it, some basic functions to encapsulate the class would be useful and easy to implement.

Projects using tooner

The following projects are using tooner:

  1. MultiTooner by Jake Brehm

Authors

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

tooner-1.1.1.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

tooner-1.1.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file tooner-1.1.1.tar.gz.

File metadata

  • Download URL: tooner-1.1.1.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.1 Darwin/20.6.0

File hashes

Hashes for tooner-1.1.1.tar.gz
Algorithm Hash digest
SHA256 4a5bde0999ca678698afadc20bafeb5a45f76f058ebc297e3d2563441a6e0e51
MD5 8975e24f206f135fe957c6e66c0d0c30
BLAKE2b-256 beecdfe80895bb512f48ef2b52e01d9692d9edf32a9f9f97bf8e95844afd45a2

See more details on using hashes here.

File details

Details for the file tooner-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: tooner-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.1 Darwin/20.6.0

File hashes

Hashes for tooner-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 049e3fcee6ee6fc58230aff47d7611b2cc7460ebe19b5c6684e53b7500110836
MD5 70da3f4f7961860edd6b5026eb6679e9
BLAKE2b-256 2d6286aecbff42a874f1e83e0d306a475ebd35517c961ffe92be6cb2aee6be69

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