Skip to content

Building: Wheels (All Platforms)

Vhou edited this page Mar 7, 2024 · 4 revisions

A wheel file can be installed with pip to run the Toontown Damage Calculator from the command line. They are normally installed from PyPi, but it is possible to build your own wheel file.

Prerequisites

In order to build a wheel for the Toontown Damage Calculator, you must install a few 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.

Once these are downloaded and installed, you are able to create a wheel for your platform!

Creating the Wheel

First, you need to clone the repository for TT-Damage-Calculator. You can do this by opening for favorite command terminal and inputting the following command:

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

Once the repository is cloned, navigate to the repository's root directory. Inside this directory, you can build the wheel with maturin:

maturin build --release

This will create a new file in the target/wheels directory. Navigate to the wheels folder, and install the created file with pip:

pip install [filename]

If you have previously installed a wheel file with the same version ID as the one you just built, you will need to add the --force-reinstall flag to the command.

Running

Once the file has been installed, you can run TT-Damage-Calculator like any other Python application installed with pip:

python -m tt_damage_calculator
Clone this wiki locally