From e42ecad6fc2542a5452882f6d3af1b7a14889214 Mon Sep 17 00:00:00 2001 From: Alex Morson Date: Tue, 19 May 2026 22:34:57 +0100 Subject: [PATCH] Recommend running with uvx uv is pretty great! Using uvx will handle installing a compatible Python version, and will install the latest version of Dusted and all of its dependencies. Though, that last point has pros and cons: it means that improvements/security patches will be picked up, but there is always a chance that a backwards incompatible change is introduced, breaking us completely. --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e39d769..cf8a815 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,34 @@ An offline editor for Dustforce replays, largely based on dustkid.com's replay c ## Installation -``` -pip install dusted +### With uv + +Using [uv](https://docs.astral.sh/uv/) will handle installing a compatible Python version, and will install and run the latest version of Dusted. + +```shell +uvx dusted ``` For extra features, copy `plugin/tas.as` to `~dustforce/user/script_src`, compile as an in-game plugin, and enable it. On linux, the program `unbuffer` is required, which can be installed with `sudo apt-get install expect` (or equivalent depending on your distribution). -## Usage +### Manual -Run the editor with +Alternatively, Dusted can be installed manually using pip. +```shell +pip install dusted ``` + +Then run with: + +```shell python -m dusted ``` -or, if the python scripts directory is on the PATH +or, if the Python scripts directory is on the PATH: -``` +```shell dusted ```