Installation

You’re just a few seconds away from exploring the interactive interface.

Requirements

Pooltool is compatible with Python >=3.8 and has been explicitly tested with the following versions:

• Python 3.8.10 (default, May 19 2021, 11:01:55)

• Python 3.9.0 (default, Nov 15 2020, 06:25:35)

• Python 3.10.0 (default, Nov 10 2021, 11:24:47) [Clang 12.0.0 ] on darwin

Install option (1): pip

GUI	API	Develop
✅	✅	❌

[Click to expand/collapse]

With a compatible python version, install via

pip install pooltool-billiards

NOTE: If you’re on Linux or Windows, you must also run this:

pip uninstall panda3d -y
pip install --pre --extra-index-url https://archive.panda3d.org/ panda3d

Install option (2): developer

GUI	API	Develop
✅	✅	✅

[Click to expand/collapse]

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.

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.

(i) create a new, python environment that uses Python 3.8.10.

With conda, you could do the following:

conda deactivate
conda env remove --name pooltool
conda create -y -n pooltool python=3.8.10
conda activate pooltool

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

$ python
Python 3.8.10 (default, May 19 2021, 11:01:55)
[Clang 10.0.0 ] :: Anaconda, Inc. on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> exit()

(ii) grab the codebase:

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

(iii) install the dependencies:

pip install -r requirements.txt
pip install -r requirements-dev.txt

In addition to requirements.txt, requirements-dev.txt includes some modules required for developement.

NOTE: If you’re on Linux or Windows, you must also run this:

pip uninstall panda3d -y
pip install --pre --extra-index-url https://archive.panda3d.org/ panda3d

(This is because there is a bug where the mouse moves off of the screen when aiming in the GUI, making you lose mouse control on Linux and Windows. The solution is to install Panda3D v1.11, which is currently unreleased but still installable.)

(iv) install the pre-commit hooks:

This will automatically format your code according to the pooltool standard whenever you commit.

pre-commit install

(v) test out your installation:

python run_pooltool

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

(vi) if you used a conda environment that you named pooltool, create this script that runs whenever the conda environment is activated. This script modifies $PATH and $PYTHONPATH so that python knows where to find pooltool libraries and the shell knows where to find the pooltool binary. These path modifications live safely inside the pooltool conda environment, and do not propagate into your global environment:

(This is a multi-line command. Paste the entire block into your command line prompt.)

mkdir -p ${CONDA_PREFIX}/etc/conda/activate.d
cat <<EOF >${CONDA_PREFIX}/etc/conda/activate.d/pooltool.sh
export PYTHONPATH=\$PYTHONPATH:$(pwd)
export PATH=\$PATH:$(pwd)
EOF

The next time you activate your conda environment (conda activate pooltool), run_pooltool (or run_pooltool.bat if you’re on Windows) is now a binary that can be run anywhere in your filesystem whenever you are in the pooltool conda environment. Test it out:

conda activate pooltool
cd ~
run_pooltool

Next

Test your installation by printing the version:

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

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