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.0.5.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tooner-1.0.5.tar.gz
  • Upload date:
  • Size: 5.7 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.0.5.tar.gz
Algorithm Hash digest
SHA256 d1bb5330c72177c5eac76c9df79a8a991ef081d1a3a11ed707d5d37480137fe2
MD5 f8155bc63a42636f09bcd51bf22cfa9e
BLAKE2b-256 cbcdfa16b896749deb4ad8fd6400970b5d96b5cd3f099a3ffd4a08e4286569d9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tooner-1.0.5-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.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7cd03ab784875a8d31f3f15b466be586cdaa6aba08d0341ec41991c816d61e16
MD5 07e62bb2da9f31e33a9e1542365b157b
BLAKE2b-256 fd18cab651ffe57df0b36bfd550540996d926cfa38edf7db3dd2c8099df3cb3f

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