Skip to main content

A Python binary package that will help you calculate gag combinations on the fly!

Project description

TT-Damage-Calculator

Badge showing the license of the Toontown Damage Calculator. Badge showing the latest release of the Toontown Damage Calculator. Badge showing the number of downloads the Toontown Damage Calculator has received.

Gag damage calculator for Toontown Rewritten.

The Program

Building

Prerequisites

  1. The Python 3 Programming Language. Install from https://www.python.org/downloads/.
  2. The Rust Programming Language. Install by following the instructions at https://www.rust-lang.org/learn/get-started.
  3. Maturin. Install by following the instructions at https://www.maturin.rs/installation.html.

Creating the wheel

Once the prerequisites are installed, clone the repository with git:

git clone https://github.com/Vhou-Atroph/TT-Damage-Calculator

With the repository cloned, navigate to the directory and build the project with maturin:

maturin build -i python

This should have created the "target" file in the project's main directory. Navigate to target/wheels and install the created file with pip:

pip install [file]

Running

After installing the wheel, you can run it from your favorite command terminal with:

python -m tt_damage_calculator

What if I don't want to build the program?

GitHub

For some versions of the calculator, I will compile it completely and release a standalone executable for users who either do not want to or are unable to compile the dependencies themselves. You can find the latest release at https://github.com/Vhou-Atroph/TT-Damage-Calculator/releases/latest.

GitHub executable releases target Windows users. Linux users must use Pypi to install this program.

Pypi

Alternatively, you can install the package using Pypi:

pip install [ill put a package name here when im sure to have it reserved]

After installing the package, you can run it via the terminal:

python -m tt_damage_calculator

Usage

Gag Selection

Click any gag on the grid to add it to the calculation.

Statuses/Modifiers

There are three buttons available above the gag selection that allow for certain functionalities: if a cog being lured that round, whether a gag is organic or not, and the ability to reset the current calculation. Other cog modifiers such as defense and v2 level can be found in the menu bar under "Calculations."

Other Features

There are two buttons in the bottom right corner of the program.
'Clear History' will clear all text in the History panel, which logs previous calculations.
'Show Health and SOS Cards' brings up a grid of all cog health values from Level 7 to Level 20, as well as the major SOS cards for Trap, Sound, and Drop. This can be toggled by clicking on it a second time.

The program has various keybinds to expedite calculation:

Keybind Description
shift Toggle Organic
ctrl+l Toggle Lure
ctrl+r Finish Calculation
ctrl+d Cycle Defense
ctrl+v Cycle v2 levels
ctrl+x Lock/Unlock statuses
alt+up Toggle Pinned Window

License

Code in TT-Damage-Calculator is licensed under the GNU General Public License v3.0.

Final Notes

ko-fi

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

tt_damage_calculator-4.2.0.tar.gz (586.7 kB view hashes)

Uploaded Source

Built Distributions

tt_damage_calculator-4.2.0-cp311-none-win_amd64.whl (1.8 MB view hashes)

Uploaded CPython 3.11 Windows x86-64

tt_damage_calculator-4.2.0-cp310-cp310-manylinux_2_34_x86_64.whl (4.0 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.34+ x86-64

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