Getting Started#
Installation#
With pip or uv, install "tiled[all]" or just "tiled[client]" if you only need
to access data (not run your own Tiled server).
With conda or pixi, install tiled or just tiled-client. Tiled is available
on the conda-forge channel, which pixi uses by default.
You will need Python 3.10 or later. You can check your version of Python by typing into a terminal:
python3 --version
It is recommended that you work in an isolated “virtual environment”, so this installation will not interfere with any existing Python software:
python3 -m venv ./venv
source ./venv/bin/activate
You can now use pip to install the library and its dependencies:
python3 -m pip install "tiled[all]"
Create a conda environment.
conda create -n try-tiled
conda activate try-tiled
Install the package.
conda install -c conda-forge tiled
Create a project.
uv init
Add tiled to it.
uv add "tiled[all]"
Create a workspace.
pixi init
Add tiled to it.
pixi add tiled
For tutorials that illustrate the purpose and utility of Tiled, see the left side-bar (or bring it into view by clicking on the upper-left ≡).