Installation

Pooltool is available on Linux, Mac, and Windows for the following Python versions:

Using pip

Pooltool is hosted on the Python Package Index (PyPI) and can be installed with pip.

LinuxMacOSWindows

pip install pooltool-billiards --extra-index-url https://archive.panda3d.org/

(Providing the Panda3D archive is required until Panda3D v1.11 is released)

From source

If you want to develop for pooltool, have access to the most up-to-date version of the codebase, or modify the code to your liking, this is for you.

[Click to expand/collapse]

A small note. If you don’t have the ability to create isolated python environments, I would recommend installing conda (here) so you can isolate pooltool from your other business.

1. Grab a copy of the codebase.

cd <A_DIRECTORY_YOU_LIKE>
git clone https://github.com/ekiefl/pooltool.git
cd pooltool

2. Create a new python environment that uses Python 3.12.4.

If you have conda, just run this:

conda env create -f environment.yml
conda activate pooltool-dev

Regardless of how you managed your python environment, please verify you’re running 3.12.4

$ python
Python 3.12.4 | packaged by Anaconda, Inc. | (main, Jun 18 2024, 10:14:12) [Clang 14.0.6 ] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> exit()

3. Install poetry, a popular python package/environment manager.

If you created your environment with conda (e.g. conda env create -f environment.yml), poetry is already part of your pooltool-dev environment.

Otherwise, install with

pip install "poetry>=1.8.3"

Verify your installation:

$ poetry --version
Poetry (version 1.8.3)

4. Install pooltool.

poetry install
pip install -e .

5. install the pre-commit hooks:

If you plan on contributing to pooltool, install the pre-commit hooks. They will automatically format your code according to the pooltool standard whenever you commit.

pre-commit install

6. test out your installation:

run-pooltool

The game window should appear (escape key to exit).

Test

Test your installation by printing the version:

python -c "import pooltool; print(pooltool.__version__)"

If installed from source, output should be 0.0.0.

Next, it’s time to learn about the interface.