Setsumeisho
一款 Minecraft 模组,用于向玩家显示游戏内的指令覆盖层,专为迷你游戏和活动设计。服务器将指令屏幕发送到客户端,显示控制键、说明和计时器——支持可选的自动翻译、电影化序列和键盘图标渲染。
功能
- 包含标题、副标题、控制键和说明部分的指令覆盖层
- 在覆盖层内渲染自定义键盘/图标字体
- 多语言内容:每个指令文件支持多个
lang 条目(如 es、en 等)
- 通过 MyMemory API 进行自动翻译(可选)
- 预翻译缓存,使玩家在打开时即可收到其语言的内容
- 通过后处理着色器实现最小化/还原动画
- 可配置倒计时的计时器显示
- 电影化支持:当指令打开时按计划运行控制台命令
- 背景纹理支持,由服务器发送至客户端
安装
- 将模组 JAR 文件放入
mods/ 文件夹。
- 启动服务器一次,以在
config/setsumeisho/default.json 生成默认配置文件。
命令
所有命令都需要操作员权限(等级 2+)。
| 命令 |
描述 |
/setsumeisho open <file> |
为执行命令的玩家打开指定名称的指令屏幕 |
/setsumeisho open <file> <player> |
为特定玩家打开指令屏幕 |
/setsumeisho close |
关闭当前打开的指令覆盖层 |
/setsumeisho create <name> |
在 config/setsumeisho/<name>.json 创建新的模板 JSON 文件 |
/setsumeisho pretranslate <file> |
预翻译指令文件并缓存结果 |
配置
所有指令文件位于 config/setsumeisho/ 中。每个文件是一个包含三个对象的 JSON 数组:语言条目、配置块和电影化块。
结构
[
{
"lang": "es",
"title": "TÍTULO",
"subtitle": "Subtítulo",
"title_controls": "Controles Especiales",
"title_description": "Instrucciones",
"controls": [
"[[ICON:LEFT_CLICK]] Descripción del control.",
"[[ICON:SPACE]] Otro control."
],
"description": "Descripción del objetivo del minijuego."
},
{
"lang": "en",
"title": "TITLE",
"subtitle": "Subtitle",
"title_controls": "Special Controls",
"title_description": "Instructions",
"controls": [
"[[ICON:LEFT_CLICK]] Control description.",
"[[ICON:SPACE]] Another control."
],
"description": "Minigame objective description."
},
{
"config": {
"timer": "00:00:10",
"minimize_scale": [0.36, 0.356],
"minimize_position": [0.57, 0.395],
"title_pos": [0.5, 0.08],
"subtitle_pos": [0.5, 0.15],
"title_controls_pos": [0.02, 0.2],
"controls_pos": [0.5, 0.25],
"title_description_pos": [0.02, 0.65],
"description_pos": [0.05, 0.7],
"title_scale": 4.0,
"subtitle_scale": 3.0,
"title_controls_scale": 1.6,
"controls_scale": 1.6,
"title_description_scale": 1.6,
"description_scale": 1.6,
"timer_pos": [0.5, 0.01],
"timer_scale": 1.45
}
},
{
"cinematics": {
"commands": [
"console_command: cam-server start wawa @a 10s",
"wait: 10s",
"console_command: say La cinemática ha finalizado."
]
}
}
]
语言条目
| 字段 |
描述 |
lang |
语言代码(es、en 等)——与客户端的语言设置匹配 |
title |
覆盖层顶部显示的主标题 |
subtitle |
标题下方显示的副标题 |
title_controls |
控制键列表的部分标题 |
controls |
控制键说明数组;支持 [[ICON:KEY]] 占位符和 \n 换行 |
title_description |
说明块的部分标题 |
description |
说明部分的正文文本 |
图标占位符
在 controls 或 description 字符串中使用 [[ICON:KEY_NAME]] 来嵌入键盘/鼠标图标。示例:
[[ICON:LEFT_CLICK]]
[[ICON:RIGHT_CLICK]]
[[ICON:SPACE]]
[[ICON:CTRL]]
[[ICON:W]], [[ICON:A]], [[ICON:S]], [[ICON:D]]
文本格式化
在任何文本字段中,你可以使用:
&<code> — Minecraft 聊天格式化代码(例如 &l 加粗,&c 红色)
#RRGGBB — 内联十六进制颜色
配置块
所有位置值均为归一化的屏幕坐标 [x, y],其中 (0, 0) 为左上角,(1, 1) 为右下角。
| 字段 |
类型 |
描述 |
timer |
"HH:MM:SS" |
顶部显示的倒计时时长 |
timer_pos |
[x, y] |
计时器位置 |
timer_scale |
float |
计时器文本缩放比例 |
minimize_scale |
[x, y] |
最小化状态小部件的缩放比例 |
minimize_position |
[x, y] |
最小化小部件的位置 |
title_pos |
[x, y] |
标题位置 |
title_scale |
float |
标题文本缩放比例 |
subtitle_pos |
[x, y] |
副标题位置 |
subtitle_scale |
float |
副标题文本缩放比例 |
title_controls_pos |
[x, y] |
控制键部分标题位置 |
title_controls_scale |
float |
控制键部分标题缩放比例 |
controls_pos |
[x, y] |
控制键列表位置 |
controls_scale |
float |
控制键列表文本缩放比例 |
title_description_pos |
[x, y] |
说明部分标题位置 |
title_description_scale |
float |
说明部分标题缩放比例 |
description_pos |
[x, y] |
说明正文位置 |
description_scale |
float |
说明正文文本缩放比例 |
电影化块
commands 数组在指令屏幕打开时按顺序运行。
| 前缀 |
示例 |
描述 |
console_command: |
console_command: say Hello |
运行服务器命令 |
wait: |
wait: 5s |
在下一个命令之前等待指定的时间 |
翻译
该模组可使用 MyMemory 免费 API 自动翻译指令内容。请在 config/setsumeisho/translation.json 中进行配置:
{
"enabled": false,
"source_lang": "es",
"api_key": ""
}
使用 /setsumeisho pretranslate <file> 预先生成翻译并缓存它们,以便客户端在打开界面时能够以自身语言接收内容,而无需等待延迟。
Setsumeisho
A Minecraft mod that displays in-game instruction overlays to players, designed for minigames and events. The server sends instruction screens to clients showing controls, descriptions, and timers — with optional auto-translation, cinematic sequences, and keyboard icon rendering.
Features
- Instruction overlay with title, subtitle, controls, and description sections
- Custom keyboard/icon font rendered inside the overlay
- Per-language content: each instruction file supports multiple
lang entries (es, en, etc.)
- Auto-translation via the MyMemory API (optional)
- Pre-translation cache so players receive content in their language on open
- Minimize/restore animation via a post-process shader
- Timer display with configurable countdown
- Cinematic support: run console commands on a schedule when an instruction opens
- Background texture support sent from server to client
Installation
- Place the mod JAR in the
mods/ folder.
- Start the server once to generate the default configuration file at
config/setsumeisho/default.json.
Commands
All commands require operator permissions (level 2+).
| Command |
Description |
/setsumeisho open <file> |
Opens the named instruction screen for the executing player |
/setsumeisho open <file> <player> |
Opens the instruction screen for a specific player |
/setsumeisho close |
Closes the currently open instruction overlay |
/setsumeisho create <name> |
Creates a new template JSON file at config/setsumeisho/<name>.json |
/setsumeisho pretranslate <file> |
Pre-translates the instruction file and caches the result |
Configuration
All instruction files live in config/setsumeisho/. Each file is a JSON array with three objects: the language entries, the config block, and the cinematics block.
Structure
[
{
"lang": "es",
"title": "TÍTULO",
"subtitle": "Subtítulo",
"title_controls": "Controles Especiales",
"title_description": "Instrucciones",
"controls": [
"[[ICON:LEFT_CLICK]] Descripción del control.",
"[[ICON:SPACE]] Otro control."
],
"description": "Descripción del objetivo del minijuego."
},
{
"lang": "en",
"title": "TITLE",
"subtitle": "Subtitle",
"title_controls": "Special Controls",
"title_description": "Instructions",
"controls": [
"[[ICON:LEFT_CLICK]] Control description.",
"[[ICON:SPACE]] Another control."
],
"description": "Minigame objective description."
},
{
"config": {
"timer": "00:00:10",
"minimize_scale": [0.36, 0.356],
"minimize_position": [0.57, 0.395],
"title_pos": [0.5, 0.08],
"subtitle_pos": [0.5, 0.15],
"title_controls_pos": [0.02, 0.2],
"controls_pos": [0.5, 0.25],
"title_description_pos": [0.02, 0.65],
"description_pos": [0.05, 0.7],
"title_scale": 4.0,
"subtitle_scale": 3.0,
"title_controls_scale": 1.6,
"controls_scale": 1.6,
"title_description_scale": 1.6,
"description_scale": 1.6,
"timer_pos": [0.5, 0.01],
"timer_scale": 1.45
}
},
{
"cinematics": {
"commands": [
"console_command: cam-server start wawa @a 10s",
"wait: 10s",
"console_command: say La cinemática ha finalizado."
]
}
}
]
Language entries
| Field |
Description |
lang |
Language code (es, en, etc.) — matched to the client's language setting |
title |
Main title shown at the top of the overlay |
subtitle |
Subtitle shown below the title |
title_controls |
Section header for the controls list |
controls |
Array of control descriptions; supports [[ICON:KEY]] placeholders and \n line breaks |
title_description |
Section header for the description block |
description |
Body text for the description section |
Icon placeholders
Use [[ICON:KEY_NAME]] inside controls or description strings to embed keyboard/mouse icons. Examples:
[[ICON:LEFT_CLICK]]
[[ICON:RIGHT_CLICK]]
[[ICON:SPACE]]
[[ICON:CTRL]]
[[ICON:W]], [[ICON:A]], [[ICON:S]], [[ICON:D]]
Text formatting
Inside any text field you can use:
&<code> — Minecraft chat formatting codes (e.g. &l bold, &c red)
#RRGGBB — Inline hex color
Config block
All position values are normalized screen coordinates [x, y] where (0, 0) is top-left and (1, 1) is bottom-right.
| Field |
Type |
Description |
timer |
"HH:MM:SS" |
Countdown duration shown at the top |
timer_pos |
[x, y] |
Timer position |
timer_scale |
float |
Timer text scale |
minimize_scale |
[x, y] |
Scale of the minimized state widget |
minimize_position |
[x, y] |
Position of the minimized widget |
title_pos |
[x, y] |
Title position |
title_scale |
float |
Title text scale |
subtitle_pos |
[x, y] |
Subtitle position |
subtitle_scale |
float |
Subtitle text scale |
title_controls_pos |
[x, y] |
Controls section header position |
title_controls_scale |
float |
Controls section header scale |
controls_pos |
[x, y] |
Controls list position |
controls_scale |
float |
Controls list text scale |
title_description_pos |
[x, y] |
Description section header position |
title_description_scale |
float |
Description section header scale |
description_pos |
[x, y] |
Description body position |
description_scale |
float |
Description body text scale |
Cinematics block
The commands array runs sequentially when the instruction screen opens.
| Prefix |
Example |
Description |
console_command: |
console_command: say Hello |
Runs a server command |
wait: |
wait: 5s |
Waits the specified time before the next command |
Translation
The mod can auto-translate instruction content using the MyMemory free API. Configure this in config/setsumeisho/translation.json:
{
"enabled": false,
"source_lang": "es",
"api_key": ""
}
Use /setsumeisho pretranslate <file> to pre-generate translations and cache them, so clients receive content in their own language without latency when the screen opens.
评论 0
登录后参与评分
还没有评论,来抢沙发吧