osu-ahr 项目使用与配置指南

osu-ahr 项目使用与配置指南

osu-ahr irc bot for osu multi lobby auto host rotation 项目地址: https://gitcode.com/gh_mirrors/os/osu-ahr

1. 项目目录结构及介绍

osu-ahr 项目是一个开源的自动主机轮换机器人，用于 osu! 游戏的多玩家模式。以下是项目的目录结构及其各部分的简要介绍：

osu-ahr/
├── .dockerignore          # Docker构建时排除的文件列表
├── .eslintignore          # ESLint检查时排除的文件列表
├── .eslintrc.yml          # ESLint配置文件
├── .gitignore             # Git提交时排除的文件列表
├── CMDLIST.md             # 命令列表文件
├── Dockerfile             # Docker构建文件
├── LICENSE                # 项目许可证文件
├── README.md              # 项目说明文件
├── TODO.md                # 待办事项列表
├── memo.md                # 项目备忘录
├── package-lock.json      # npm包版本锁定文件
├── package.json           # npm项目配置文件
├── tsconfig.json          # TypeScript配置文件
├── config/                # 配置文件目录
│   ├── default.json       # 默认配置文件
│   └── local.json         # 本地配置文件
└── src/                   # 源代码目录

• config/: 包含项目配置文件，default.json 是默认配置，local.json 是本地定制配置。
• src/: 源代码目录，包含项目的所有JavaScript代码。
• README.md: 项目的主要说明文件，介绍了项目的用途、安装和配置方法。
• CMDLIST.md: 包含项目支持的所有命令及其描述。

2. 项目的启动文件介绍

项目的启动文件是 package.json 中的 scripts 部分，它定义了启动项目所需的命令。以下是启动项目的常见命令：

"scripts": {
  "start": "node dist/index.js"
}

使用以下命令可以启动项目：

npm run start

这将运行 node dist/index.js，启动整个机器人。

3. 项目的配置文件介绍

项目的主要配置文件是位于 config/ 目录下的 local.json 文件。以下是该配置文件的一些基本设置：

{
  "irc": {
    "server": "irc.ppy.sh",
    "nick": "your_account_id",
    "opt": {
      "port": 6667,
      "password": "your_irc_password"
    }
  },
  "Lobby": {
    "authorized_users": [
      "peppy",
      "abcedf"
    ],
    "listref_duration_ms": 1000,
    "info_message": [
      "welcome to ahr lobby!",
      "The second item is displayed on the second line.",
      "Too many lines will result in a silent penalty"
    ],
    "info_message_cooltime_ms": 60000,
    "stat_timeout_ms": 5000,
    "info_message_announcement_interval_ms": 0
  }
}

• irc: IRC服务器的配置，包括服务器地址、昵称、端口和密码。
• Lobby: 大厅相关的配置，包括授权用户列表、命令的等待时间、欢迎信息、信息冷却时间、统计超时时间以及信息公告间隔时间。

请根据实际情况修改 local.json 文件中的配置，例如替换 irc 部分的 server、nick 和 password 字段的值为你自己的IRC服务器地址、昵称和密码。

osu-ahr irc bot for osu multi lobby auto host rotation 项目地址: https://gitcode.com/gh_mirrors/os/osu-ahr