Skip to content

Recommend running with uvx #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexMorson merged 1 commit into from
May 19, 2026
Merged

Recommend running with uvx #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```