docs: 添加 README

This commit is contained in:
2024-02-26 02:01:40 +08:00
parent 015a662036
commit 6403e1b1f9
4 changed files with 49 additions and 0 deletions

34
README.md Normal file
View File

@@ -0,0 +1,34 @@
# HamsterTPA
这是一款支持跨服传送的 tpa 插件,就像你在 Essentials 或 CMI 中用过的 tpa 功能那样,只不过这个插件支持跨服
# 手动构建
1. 将源代码下载或克隆至本地
2. 在源代码根目录中打开命令行窗口
3. 命令行窗口中执行`./gradlew clean build`
4. 构建成品在 `build` 文件夹
也可访问我的[Jenkins网站](https://jenkins.airgame.net/job/opensource/job/hamster-tpa/)获取最新版
# 前置插件
- [HamsterCore](https://git.airgame.net/MiniDay/hamster-core/)
- [HamsterBall](https://git.airgame.net/MiniDay/hamster-ball/)
# 指令
| 指令 | 权限 | 描述 |
|:-----------|:----------------|:----------|
| /tpa <玩家名> | hamster.tpa.use | 向玩家发送传送申请 |
| /tpaccept | hamster.tpa.use | 接受传送申请 |
| /tpdeny | hamster.tpa.use | 拒绝传送申请 |
# 安装步骤
1. 安装步骤
2. 关闭服务器
3. 下载插件后将其放置在`plugins`文件夹
4. 启动服务器生成插件配置文件夹
5. 编辑`plugins/HamsterTpa`文件夹内的配置文件以符合预期
6. 重启服务器

View File

@@ -39,6 +39,11 @@ public final class TPACommand extends ParentCommand {
return HamsterTPAPlugin.getInstance(); return HamsterTPAPlugin.getInstance();
} }
@Override
public boolean hasPermission(@NotNull CommandSender sender) {
return sender.hasPermission("hamster.tpa.use");
}
@Override @Override
public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, String[] args) { public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, String[] args) {
if (!(sender instanceof Player)) { if (!(sender instanceof Player)) {

View File

@@ -35,6 +35,11 @@ public final class TPAcceptCommand extends ParentCommand {
return HamsterTPAPlugin.getInstance(); return HamsterTPAPlugin.getInstance();
} }
@Override
public boolean hasPermission(@NotNull CommandSender sender) {
return sender.hasPermission("hamster.tpa.use");
}
@Override @Override
public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, String[] args) { public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, String[] args) {
if (!(sender instanceof Player)) { if (!(sender instanceof Player)) {

View File

@@ -36,6 +36,11 @@ public final class TPDenyCommand extends ParentCommand {
return HamsterTPAPlugin.getInstance(); return HamsterTPAPlugin.getInstance();
} }
@Override
public boolean hasPermission(@NotNull CommandSender sender) {
return sender.hasPermission("hamster.tpa.use");
}
@Override @Override
public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, String[] args) { public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, String[] args) {
if (!(sender instanceof Player)) { if (!(sender instanceof Player)) {