README-en.md

MaaDebugger

s

简体中文 | English

Note

We are currently refactoring MaaDebugger. You can visit #163 for more details and to get an early preview version.

Requirement

• Python >= 3.9, <= 3.13
• nicegui >= 2.21,< 3.0

Quick Start

Using uv

Provides faster installation speed and environment isolation.

• Install as a global tool:

  uv tool install MaaDebugger
  MaaDebugger

• Run temporarily (No installation required):

  uvx MaaDebugger

• Update:

  uv tool upgrade MaaDebugger

---

Using Python (pip)

Traditional Python installation method.

• Install:

  python -m pip install MaaDebugger

• Run:

  python -m MaaDebugger

• Update:

  python -m pip install MaaDebugger MaaFW --upgrade

---

Specify Port

MaaDebugger uses port 8011 by default. You can specify a port to run MaaDebugger on by using the --port [port] option. For example, to run MaaDebugger on port 8080: The --port parameter is supported across all methods. For example, to run on port 8080:

# uv
MaaDebugger --port 8080

# uvx (No installation required)
uvx MaaDebugger --port 8080

# python
python -m MaaDebugger --port 8080

Development of MaaDebugger itself

cd src
python -m MaaDebugger

or

Using VSCode, press F5 in the project directory.