# Impulse
Impulse 是一个为 Minecraft 服务器代理 [Velocity](https://papermc.io/software/velocity) 设计的插件。它增加了动态启动和停止服务器的能力,以响应玩家的加入和离开。为什么还要运行仅用于每天几个小时的服务器呢?
## 主要特性
Impulse 具有许多功能,可以轻松管理您的服务器!一些亮点包括:
* 动态服务器创建和销毁 - 仅在您的玩家连接时才运行服务器
* 第一方和第三方代理 - 核心驱动您的服务器,无论它们如何部署,通过 Docker、JAR 文件或其它方式。我们正在积极扩展我们的选择,您可以在
[此处](https://arson-club.github.io/Impulse/reference/brokers.html) 找到完整列表
* 自动配置热重载 - 自动更新 Impulse 运行服务器的方式,无需重新加载命令!
* 无管理服务器支持 - 与 Velocity 中配置的任何静态服务器配合良好
* 自定义事件 - 广播自定义事件,以便扩展 Impulse 的功能
* 第三方代理支持 - 实现您自己的代理或使用他人的代理来管理您的服务器
* 开放源码 - Impulse 致力于始终保持免费和开放源码
## 文档
有关如何使用 Impulse 的更多详细信息,请参阅我们的 [文档](https://arson-club.github.io/Impulse/)。
有关 API 文档,请参阅我们的 [KDocs](https://arson-club.github.io/Impulse/kdocs/index.html)。
## 安装
简而言之,从我们的资源之一下载最新版本,并将其放置在 Velocity 插件文件夹中。有关更详细的说明,请参阅我们的 [安装](https://arson-club.github.io/Impulse/getting_started/installation.html)
指南。
资源:
- [Modrinth](https://modrinth.com/plugin/impulse-server-manager)
- [Hangar](https://hangar.papermc.io/ArsonClub/Impulse)
- [GitHub Releases](https://github.com/Arson-Club/Impulse/releases)
## 快速开始
> [!TIP]
> 正在寻找更深入的指南?请参阅我们的 [入门](https://arson-club.github.io/Impulse/getting_started/index.html)
> 文档。
以下配置应帮助您入门简单的 Lobby 服务器。
### 第一步:配置 Velocity
只需将服务器添加到 Velocity 配置中即可,就像平常一样。
```toml
player-info-forwarding = "modern"
[servers]
lobby = "127.0.0.1:25566"
try = ["lobby"]
```
### 第二步:配置 Impulse
配置 impulse,使其知道如何管理您的服务器
```yaml
instanceName: Bones
servers:
- name: lobby
inactiveTimeout: 300
type: docker
docker:
image: itzg/minecraft-server
portBindings:
- "25566:25565"
env:
ONLINE_MODE: "FALSE"
TYPE: "FABRIC"
EULA: "TRUE"
MODRINTH_PROJECTS: "fabricproxy-lite"
DIFFICULTY: "PEACEFUL"
ALLOW_NETHER: "FALSE"
MODE: "adventure"
volumes:
- "/srv/lobby:/data"
```
### 第三步:配置 MC 服务器
添加一些配置以允许进行现代转发
```toml
# 创建文件 /srv/lobby/config/FabricProxy-Lite.toml
hackOnlineMode = true
hackEarlySend = false
hackMessageChain = true
disconnectMessage = "This server requires you to connect through the proxy."
secret = ""
```
### 第四步:连接
只需启动您的 Velocity 代理并从您的 Minecraft 客户端连接即可。如果您遇到问题,请查看
我们的 [文档](https://arson-club.github.io/Impulse/) 或打开一个问题!
## 获取帮助
如果您在使用 Impulse 时遇到问题、出现错误,或只是想推荐一个功能,请随时
[打开一个问题](https://github.com/Arson-Club/Impulse/issues/new?template=Blank+issue)! 我会尽力
回复。
## 贡献
所有贡献都欢迎!有关更具体的说明,请参阅我们的 [贡献](https://arson-club.github.io/Impulse/contributing/contributing.html)
页面。
有关添加创建您自己的代理以与其他服务器平台集成有关的特定信息
请参阅 [我们的指南](https://arson-club.github.io/Impulse/contributing/creating-a-broker.html)。