README.md

AutoRestart 自动重启

插件介绍

功能介绍

• 多语言（根据玩家客户端的语言进行匹配）
• 播放音效提醒玩家（暂时只支持mc原有的）
• 取消自动重启任务
• 暂停任务

任务类型

• 自动重启
• 手动重启（手动重启的时间为配置文件中的提示时间）
• 服务器无人时自动重启
• 投票重启
• 定时重启

命令与权限

命令	权限节点	命令/权限介绍	权限归属
/autorestart	autorestart.admin	主命令、打开GUI	OP
/autorestart reload	autorestart.admin.reload	重载配置文件
/autorestart cancel	autorestart.admin.cancel	取消重启任务
/autorestart pause	autorestart.admin.pause	暂停/继续运行重启任务
/autorestart restart [任务类型] (时间单位) (时间)	autorestart.admin.restart	手动重启服务器
/voterestart	autorestart.user.vote	主命令、打开GUI	player
/voterestart initiate		发起投票
/voterestart vote approval		投出赞成票
/voterestart vote oppose		投出反对票
/voterestart vote abstention		投出弃权票
/voterestart vote veto	autorestart.admin.vote.veto	使用一票否决	OP
	autorestart.admin.vote.force	在调试模式中强制发起投票 该功能方便开发而设立的(需开启debug模式)
	autorestart.admin.reload	在线修改配置文件 注： 跟重载配置文件的权限相同但无相关命令

命令参数讲解

• [ ] 内的参数必填
• （ ） 内的参数选填

任务类型

• manual 手动重启
• no-players 无人时重启
• scheduled 定时重启

时间单位

• hour 小时
• minutes 分钟
• seconds 秒

配置文件介绍

config.yml

# 配置文件版本（勿动!!!）
version: 12
# 默认语言
default_language: zh_CN
# 重启时间(分钟 min)
restart_time: 180
# 提示时间(秒 s)
pre_restart_tip_time: 30
#  是否在重启前把玩家踢出
kick_player: true
# 一些显示的设置
# 显示title(包括subtitle)
show_title: true
# 底部显示(在物品栏上方)
show_tip: true
# 是否播放音效
play_sound: true
sound:
  name: "random.toast"
  volume: 1.0
  pitch: 0.5
# 重启前执行的命令(&con为控制台执行 @p 代表玩家名)
runcommand: true
commands:
  global:
    # 全局性的命令，需要在关服前执行的命令（注意，如果需要每一名玩家都执行命令的请在 player 的命令配置中填写）
    - "list"
    - "status"
  player:
    # 为每一名玩家执行的命令
    # &con为控制台执行 @p代表玩家名 ( 只有为每一名玩家都执行的命令 @p 与 &con 才会生效 )
    - "help"
    - "say hello @p&con"
# 发起重启投票的最低人数（最低只能为3）
vote_start_player: 3
# 投票的时间限制（最高只能为5 (分钟 min)）
vote_time: 5
# 调试模式
debug: false
# 消息前缀
message_prefix: "§l§bAutoRestart §r§7>> "
# 本地化语言文件（开启后语言文件才会保存至插件对应文件及其会使用保存至插件文件夹的语言文件）
local_language_flies: false
# 显示投票状态
prompt_voting_status: true
# 显示投票状态的类型
# 0 = ActionBar，1 = tip，2 = popup
prompt_type: 0
# 忽略剩余时间，启用后当赞成票数达到要求不需要等到投票结束就执行相关功能
ignore_vote_remainder_time: false
# 定时提醒服务器执行的剩余时间
## 是否启用
enable_reminder_timer: true
## 广播周期 （单位：分钟）
broadcast_restart_reminder_cycle: 30

支持的语言

• 顺序按照支持的顺序排序
• zh_CN 中文(简体)
• zh_TW 中文(繁體)
• en_US English (United States)

变量信息

• 对接Tips的变量信息

变量	介绍
{restart-remainder}	获取重启任务的剩余时间
{vote-data}	获取投票重启的数据
{vote-remainder}	获取投票重启任务的剩余时间

使用方法

步骤	说明
1	准备好相关的启动脚本并放置在服务端的根目录下 （一般情况下启动脚本是放置在服务端的根目录下） 并调整好启动脚本的配置 (如果你拥有并使用相关的启动脚本则无视这一步骤)
2	将本插件放进plugins文件夹，并确保安装前置插件MemoriesOfTime-GameCore后启动服务器 安装前置插件Tips对接的变量生效（这是可选的）
3	如果不使用默认配置则修改好配置文件后重启服务器让新的配置生效（由于自动重启任务的配置读取是在服务器启动阶段进行的，所以无法通过重载配置文件的操作让新的配置完全生效只能通过重启服务器来让新的配置生效）

注意事项

1. 自动重启还需要脚本的配合才能实现，相关脚本会在 Github Actions 中编译完成后会一并给出，也可以到对应 GITHUB 仓库 中获取，Releases 界面也可以获取得到相关脚本，但只会在版本发布后才会有相关脚本( Windows用.bat后缀的脚本，Linux请用.sh后缀的脚本，另外每种系统的脚本都有两种，建议根据实际需求选用 )，如果你已经拥有了相关脚本则可以忽略这一点
2. 本插件会受 TPS 的影响可能会导致跟时间相关的数据计算不准确！
3. 在使用时请不要随意改动语言文件或配置文件的版本号，否则所带来的后果一切自负！！！！！！
4. 默认情况下使用的语言文件为内置的语言文件，如果有修改语言文件的需求请将 local_language_flies 的 false 改为 true

脚本使用说明

• 此内容使用于配套的启动脚本，可配置项已在下方列出
• 如果你没有相关知识，请不要修改可配置项以外的地方
• 可配置项是在=后面的，例如jvm_ram_xms="512M"的512M就为可配置项, 注：""可加可不加，如果无法运行可尝试加上""

Windows

::设置用于启动的java版本 (默认填 java，当然你也可以填java的安装路径)
set java_version=java
::服务器名提示
set server_name=test
::设置最小内存
set ram_Xms=512m
::设置最大内存
set ram_Xmx=1024m
::设置开服核心名(开服核心名不用加.jar的后缀名)
set server_jar_name=server
::设置重启等待时间
set restart_time=20

Linux

ReStart_Time=5s  #等待多少秒后重启要加时间单位
jvm_ram_xms="512M"  #设置最小内存
jvm_ram_xmx="1024M"  #设置最大内存
jar_name="server.jar"  #开服核心的名字记得加.jar后缀名
server_name="testmc"  #服务名(方便维护用的)，比如说是生存服就将testmc改为生存服

效果预览

开发文档

• 请在Releases界面下载-javadoc.jar结尾的文件解压后点击index.html获取相关文档
• 

Maven

<repository>
	<id>jitpack.io</id>
	<url>https://jitpack.io</url>
</repository>

<dependency>
	<groupId>com.github.stevei5mc</groupId>
	<artifactId>AutoRestart</artifactId>
	<version>1.0.1</version>
</dependency>

Gradle

• gradle.kts

  maven("https://jitpack.io")

  compileOnly("com.github.stevei5mc:AutoRestart:1.0.1")