# VanishBridge
VanishBridge 是一个简单的插件，它在代理级别提供有关已消失玩家的信息。 它的设计目的是供其他插件使用，以提供更好的玩家体验。
目前，VanishBridge 支持以下代理软件：
- [Velocity](https://velocitypowered.com/)
以及以下后端服务器软件：
- [Paper](https://papermc.io/)
如果您缺少代理或后端服务器软件，请随时打开问题或创建拉取请求。
## 给服务器所有者
### 安装
VanishBridge 的安装非常简单。
1. 从 [发布页面](https://modrinth.com/plugin/vanishbridge/versions?l=velocity) 下载适用于您的代理软件的版本（例如 Velocity）。
2. 将下载的 jar 文件放入您的代理的 `plugins` 文件夹中。
3. 重启您的代理。
4. 从 [发布页面](https://modrinth.com/plugin/vanishbridge/versions?l=paper) 下载适用于您的后端服务器软件的版本（例如 Paper）。
5. 将下载的 jar 文件放入每个服务器的 `plugins` 文件夹中。
6. 重启您的服务器。
7. 享受吧！
### 配置
无需配置！
## 给开发者
### 安装
#### Maven
```xml
loapu-releases
Loapu Maven Repository
https://repo.loapu.dev/releases
dev.loapu.vanishbridge
vanishbridge-api
1.0
```
#### Gradle
```
repositories {
maven("https://repo.loapu.dev/releases")
}
dependencies {
implementation("dev.loapu.vanishbridge:vanishbridge-api:VERSION")e
}
```
### [JavaDocs](https://repo.loapu.dev/javadoc/releases/dev/loapu/vanishbridge/vanishbridge-api/latest)
### 用法
#### 检查 VanishBridge 是否已安装 (Velocity)
```java
@Plugin(
id = "velocityexample",
name = "VelocityExample",
version = "1.0.0",
dependencies = {
@Dependency(id = "vanishbridge", optional = true)
}
)
public class VelocityExample
{
// 确保在您的插件类中添加此项，如果将 VanishBridge 声明为可选
public boolean isVanishBridgeInstalled()
{
return proxyServer.getPluginManager().isLoaded("vanishbridge");
}
// 现在你可以使用 VanishBridge 了
public void example()
{
if (!isVanishBridgeInstalled()) return;
VanishBridge vanishBridge = VanishBridgeProvider.get();
}
}
```
#### 获取已消失玩家列表
```java
import dev.loapu.vanishbridge.api.VanishBridge;
import dev.loapu.vanishbridge.api.model.VanishBridgePlayer;
import dev.loapu.vanishbridge.api.VanishBridgeProvider;
public class Example {
// 非常简单
public List vanishedPlayers = VanishBridgeProvider.get().vanishedPlayers();
}
```
就是这样！现在您可以在您的插件中使用 VanishBridge 了。