添加了readme

支持了重载配置
This commit is contained in:
张宇衡 2023-06-02 17:35:51 +08:00
parent a9fd205c0c
commit 4e076e0afc
3 changed files with 151 additions and 5 deletions

44
.github/workflows/main.yml vendored Normal file
View File

@ -0,0 +1,44 @@
name: Java CI with Maven
# 检测到 src 文件内 .java 文件有变动执行编译
on:
push:
paths:
- '**/*src/**/*.java'
jobs:
build:
# 配置权限
permissions: write-all
runs-on: ubuntu-latest
steps:
# 下载代码
- uses: actions/checkout@v3
- name: Set up JDK 17
# 安装 JDK
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
cache: maven
# Maven 打包
- name: Build with Maven
run: mvn -B package --file pom.xml
# 将打包好的 Jar 包 放到 staging 文件夹
- run: mkdir staging && cp target/*.jar staging
# 设置 jobs Maven pom 版本环境变量
- name: Set Release version env variable
run: |
echo "RELEASE_VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)" >> $GITHUB_ENV
- name: "Build & test"
run: |
echo "done!"
# 上传文件并发布 Release
- uses: "marvinpinto/action-automatic-releases@latest"
with:
repo_token: "${{ secrets.GITHUB_TOKEN }}"
automatic_release_tag: "${{ env.RELEASE_VERSION }}"
prerelease: false
title: "Release ${{ env.RELEASE_VERSION }}"
files: |
staging/*.jar

80
README.md Normal file
View File

@ -0,0 +1,80 @@
# LiteWorldEdit
## 轻量创世神
适用于生存服务器的轻量级创世神插件。
## 说明
这个插件也是很早之前在mcbbs见过一个类似的但是后面找不到了也不知道原作者是否有继续维护。
对于一些玩家来说平整区域、铺地板这样的重复性机械劳动是一件很痛苦的事。
原版的创世神插件很强大,但是在生存模式的服务器中存在一些问题:
1. 权限过高,很容易误操作;
2. 虽然填充可以开启“消耗玩家物品栏”,但是对于破坏操作没有任何限制;
3. 创世神采用的是直接在主线程执行任务,因此如果大量玩家在同一时间操作大量方块会不可避免地造成服务器卡死;
由此便诞生了本插件,适用于想要尽可能减少重复性机械劳动的建筑党。
> 本人是C++程序员在此之前没有写过Java。所以如果发现代码里有不合理的地方欢迎指出。
## 功能介绍
1. 采用异步的方式执行操作玩家提交的操作会被放入一个队列中每tick只会从队列中取出一个操作进行执行因此不会造成服务器卡顿
2. 使用破坏操作需要拥有下届合金镐(作为一种使用门槛),并且消耗耐久度,同时支持耐久附魔效果;
3. 当合金镐耐久度不足10时会自动终止任务暂不支持恢复
4. 支持填充操作,填充操作需要消耗玩家物品栏中的物品;
5. 禁止超视距操作128以外防止玩家利用创世神插件加载大量区块导致服务器卡顿
## 支持版本
- 1.17 及以上 Bukkit/Spigot/Paper
## 使用方法
1. 将插件放入服务器的 `plugins` 目录下
2. 重启服务器
3. 在 `plugins/LiteWorldEdit/config.yml` 中配置
4. 控制台或OP输入 `/lwe reload` 重载配置
## 指令
### 玩家指令
`/lwe help` 查看帮助
`/lwe point [点序号(整数)] [x] [y] [z]` 创建点
`/lwe p [点序号(整数)] [x] [y] [z]` 创建点
`/lwe points` 查看当前添加的所有点
`/lwe fill [点序号A] [点序号B]` 在AB点对角线间放置方块 - 需要手持被放置的方块
`/lwe empty [点序号A] [点序号B]` 破坏AB点对角线间方块 - 需要拥有下届合金镐
`/lwe cancel` 取消(终止)所有任务
`/lwe reload` 重载配置(仅管理员)
## 配置文件参考
```yaml
MaxX: 64
MaxY: 64
MaxZ: 64
Debug: false
```
## TODO
- [ ] 选区可视化
- [ ] 可手动暂停、恢复任务
- [ ] 更多的任务类型支持(如画圆、弧线)

View File

@ -20,9 +20,9 @@ public class Commands implements TabExecutor {
@Override
public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
if (args.length == 0) {
sender.sendMessage(ChatColor.GREEN + "LiteWorldEdit by DeerCloud");
sender.sendMessage(ChatColor.GREEN + "使用 /lwe help 查看帮助。");
return true;
sender.sendMessage(ChatColor.GREEN + "LiteWorldEdit by DeerCloud");
sender.sendMessage(ChatColor.GREEN + "使用 /lwe help 查看帮助。");
return true;
}
if (Objects.equals(args[0], "point") || Objects.equals(args[0], "p")) {
if (sender instanceof Player) {
@ -140,6 +140,27 @@ public class Commands implements TabExecutor {
}
} else if (Objects.equals(args[0], "help")) {
print_help(sender);
} else if (Objects.equals(args[0], "cancel")) {
if (sender instanceof Player) {
Player player = (Player) sender;
LiteWorldEdit.instance.getCache().deleteAllJobsOfPlayer(player);
sender.sendMessage("已取消。");
} else {
sender.sendMessage("该命令只能由玩家执行。");
}
} else if (Objects.equals(args[0], "reload")) {
if (sender instanceof Player) {
Player player = (Player) sender;
if (!player.isOp()) {
sender.sendMessage("你没有权限。");
} else {
LiteWorldEdit.instance.reloadConfig();
sender.sendMessage("已重载配置文件。");
}
} else {
LiteWorldEdit.instance.reloadConfig();
sender.sendMessage("已重载配置文件。");
}
} else {
sender.sendMessage("参数错误。");
}
@ -149,7 +170,7 @@ public class Commands implements TabExecutor {
@Override
public List<String> onTabComplete(CommandSender sender, Command command, String alias, String[] args) {
if (args.length == 1) {
return Arrays.asList("point", "p", "points", "fill", "empty", "help");
return Arrays.asList("point", "p", "points", "fill", "empty", "cancel", "help", "reload");
} else if (args.length == 2) {
switch (args[1]) {
case "point":
@ -165,11 +186,12 @@ public class Commands implements TabExecutor {
public void print_help(CommandSender sender) {
sender.sendMessage(ChatColor.GREEN + "LiteWorldEdit 帮助");
sender.sendMessage(ChatColor.GREEN + "/lwe help - 查看帮助");
sender.sendMessage(ChatColor.GREEN + "/lwe point|p [点序号(整数)] [x] [y] [z] - 创建点");
sender.sendMessage(ChatColor.GREEN + "/lwe points - 查看所有点");
sender.sendMessage(ChatColor.GREEN + "/lwe fill [点序号A] [点序号B] - (在AB点对角线间放置方块 - 需要手持被放置的方块)");
sender.sendMessage(ChatColor.GREEN + "/lwe empty [点序号A] [点序号B] - (破坏AB点对角线间方块 - 需要拥有下届合金镐)");
sender.sendMessage(ChatColor.GREEN + "/lwe help - 查看帮助");
sender.sendMessage(ChatColor.GREEN + "/lwe cancel - 取消所有任务");
}
static public boolean out_of_region(Point A, Point B) {