Development Setup

Everything you need to get a local development environment running for Joystick Diagrams.

Prerequisites

Git
uv: Python project and dependency manager (install uv). Handles Python installation, virtual environments, and lockfile sync in one tool.

Repository Setup

Clone the repository and navigate into it:

terminal

git clone https://github.com/Rexeh/joystick-diagrams.git
cd joystick-diagrams

Sync dependencies. This also creates a .venv and pins the right Python version from pyproject.toml for you:
terminal
```
uv sync
```
Run any project command through uv (it auto-activates the venv):
terminal
```
uv run python -m joystick_diagrams
```

Joystick Diagrams moved from Poetry to uv and from mypy to ty in 2.2.0. If you have an older checkout using Poetry, clone fresh or delete poetry.lock and .venv before running uv sync.

Building

Use Make with the included Makefile to build the standalone binary and installer package:

terminal

make build-exe

Output goes to the /build directory.

Builds must run on Windows. The app supports cross-platform in principle, but the primary target is Windows.

Next Steps

Creating Parser Plugins: add support for new games
Creating Output Plugins: deliver diagrams to other applications
Input Library Reference: the shared data model

Questions or want to contribute? Join the Discord server.