CONTRIBUTING.md

贡献指南

软件发版前要做的事情

1. version.py 更新版本号

部署开发环境

在本地部署 Python3.13 环境

Download Python

下载项目源码，并进入到项目根目录

git clone https://github.com/HowieHz/osu-beatmap-to-mania-converter && cd osu-beatmap-to-mania-converter/

创建虚拟环境

py -3.13 -m venv .venv

如果你的系统没有 py 启动器，请确保当前的 python 版本为 3.13 再执行：

python -m venv .venv

进入虚拟环境

在 Windows 环境下

.\.venv\Scripts\Activate.ps1

在 CMD

\.venv\Scripts\activate.bat

在 Bash（Linux/macOS）

source ./.venv/bin/activate

附：退出虚拟环境的指令

deactivate

安装项目所需库

主程序依赖

pip install -r requirements.txt

难度图生成程序依赖

pip install -r requirements-main_generate_beatmap_difficulty_data_chart.txt

开发依赖

pip install -r requirements-dev.txt

创建 pre-commit 钩子，以便在每次提交前自动格式化代码

pre-commit install

怎么打开 DEBUG 模式

对于交互式程序 interactive_interface.py 根据你的环境，用对应的方法设置环境变量，使得 DEBUG_FLAG=True

在 Bash

export DEBUG_FLAG=True

在 PowerShell

$env:DEBUG_FLAG="True"

在 CMD

set DEBUG_FLAG=True

构建二进制文件

使用 nuitka 库

安装 nuitka 库

pip install nuitka

生成二进制文件

nuitka .\src\main.py --standalone --onefile