# Setsumeisho<\/p>\n
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 \u2014 with optional auto-translation, cinematic sequences, and keyboard icon rendering.<\/p>\n
—<\/p>\n
## Features<\/p>\n
– Instruction overlay with title, subtitle, controls, and description sections
\n– Custom keyboard\/icon font rendered inside the overlay
\n– Per-language content: each instruction file supports multiple `lang` entries (`es`, `en`, etc.)
\n– Auto-translation via the MyMemory API (optional)
\n– Pre-translation cache so players receive content in their language on open
\n– Minimize\/restore animation via a post-process shader
\n– Timer display with configurable countdown
\n– Cinematic support: run console commands on a schedule when an instruction opens
\n– Background texture support sent from server to client<\/p>\n
—<\/p>\n
## Installation<\/p>\n
1. Place the mod JAR in the `mods\/` folder.
\n2. Start the server once to generate the default configuration file at `config\/setsumeisho\/default.json`.<\/p>\n
—<\/p>\n
## Commands<\/p>\n
All commands require operator permissions (level 2+).<\/p>\n
| Command | Description | —<\/p>\n ## Configuration<\/p>\n 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**.<\/p>\n ### Structure<\/p>\n “`json ### Language entries<\/p>\n | Field | Description | ### Icon placeholders<\/p>\n Use `[[ICON:KEY_NAME]]` inside `controls` or `description` strings to embed keyboard\/mouse icons. Examples:<\/p>\n – `[[ICON:LEFT_CLICK]]` ### Text formatting<\/p>\n Inside any text field you can use: ### Config block<\/p>\n All position values are normalized screen coordinates `[x, y]` where `(0, 0)` is top-left and `(1, 1)` is bottom-right.<\/p>\n | Field | Type | Description | ### Cinematics block<\/p>\n The `commands` array runs sequentially when the instruction screen opens.<\/p>\n | Prefix | Example | Description | ---<\/p>\n ## Translation<\/p>\n The mod can auto-translate instruction content using the MyMemory free API. Configure this in `config\/setsumeisho\/translation.json`:<\/p>\n ```json Use `\/setsumeisho pretranslate Recreate the instructions from Eufonia Studios that were used in Squid Craft Games and DEDsafio<\/p>\n","protected":false},"featured_media":137798,"template":"","meta":{"_minecraft_slug":"setsumeisho","_minecraft_project_id":"ndi5VMKv","_minecraft_author":"ELBGG","_minecraft_license":"LicenseRef-CCUL-ELBGG","_minecraft_downloads":231,"_minecraft_follows":2,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"setsumeisho.zip","_minecraft_size_bytes":11079532,"_minecraft_version_count":10,"_minecraft_updated_at":"2026-05-16T12:24:14.353390Z","_minecraft_date_created":"2026-04-29T23:57:14.429864Z","_minecraft_date_modified":"2026-05-03T20:58:46.738098Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/setsumeisho","_minecraft_icon_attachment_id":137798,"_minecraft_imported_at":"2026-06-08T03:35:59+00:00","_minecraft_import_hash":"29e3a4dc1f69209800809820f1e87d0f","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,97,104,89,866,127,128,129,123],"mod_loader":[130,99,106,132,133,134],"minecraft_version":[36,94,37],"class_list":["post-137797","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-fabric","mod_category-forge","mod_category-game-mechanics","mod_category-minigame","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-technology","mod_loader-bukkit","mod_loader-fabric","mod_loader-forge","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-20-1","minecraft_version-1-20-4","minecraft_version-1-21-1"],"yoast_head":"\n
\n|—|—|
\n| `\/setsumeisho open
\n| `\/setsumeisho open
\n| `\/setsumeisho close` | Closes the currently open instruction overlay |
\n| `\/setsumeisho create
\n| `\/setsumeisho pretranslate
\n[
\n {
\n “lang”: “es”,
\n “title”: “T\u00cdTULO”,
\n “subtitle”: “Subt\u00edtulo”,
\n “title_controls”: “Controles Especiales”,
\n “title_description”: “Instrucciones”,
\n “controls”: [
\n “[[ICON:LEFT_CLICK]] Descripci\u00f3n del control.”,
\n “[[ICON:SPACE]] Otro control.”
\n ],
\n “description”: “Descripci\u00f3n del objetivo del minijuego.”
\n },
\n {
\n “lang”: “en”,
\n “title”: “TITLE”,
\n “subtitle”: “Subtitle”,
\n “title_controls”: “Special Controls”,
\n “title_description”: “Instructions”,
\n “controls”: [
\n “[[ICON:LEFT_CLICK]] Control description.”,
\n “[[ICON:SPACE]] Another control.”
\n ],
\n “description”: “Minigame objective description.”
\n },
\n {
\n “config”: {
\n “timer”: “00:00:10”,
\n “minimize_scale”: [0.36, 0.356],
\n “minimize_position”: [0.57, 0.395],
\n “title_pos”: [0.5, 0.08],
\n “subtitle_pos”: [0.5, 0.15],
\n “title_controls_pos”: [0.02, 0.2],
\n “controls_pos”: [0.5, 0.25],
\n “title_description_pos”: [0.02, 0.65],
\n “description_pos”: [0.05, 0.7],
\n “title_scale”: 4.0,
\n “subtitle_scale”: 3.0,
\n “title_controls_scale”: 1.6,
\n “controls_scale”: 1.6,
\n “title_description_scale”: 1.6,
\n “description_scale”: 1.6,
\n “timer_pos”: [0.5, 0.01],
\n “timer_scale”: 1.45
\n }
\n },
\n {
\n “cinematics”: {
\n “commands”: [
\n “console_command: cam-server start wawa @a 10s”,
\n “wait: 10s”,
\n “console_command: say La cinem\u00e1tica ha finalizado.”
\n ]
\n }
\n }
\n]
\n“`<\/p>\n
\n|—|—|
\n| `lang` | Language code (`es`, `en`, etc.) \u2014 matched to the client’s language setting |
\n| `title` | Main title shown at the top of the overlay |
\n| `subtitle` | Subtitle shown below the title |
\n| `title_controls` | Section header for the controls list |
\n| `controls` | Array of control descriptions; supports `[[ICON:KEY]]` placeholders and `n` line breaks |
\n| `title_description` | Section header for the description block |
\n| `description` | Body text for the description section |<\/p>\n
\n– `[[ICON:RIGHT_CLICK]]`
\n– `[[ICON:SPACE]]`
\n– `[[ICON:CTRL]]`
\n– `[[ICON:W]]`, `[[ICON:A]]`, `[[ICON:S]]`, `[[ICON:D]]`<\/p>\n
\n– `&` \u2014 Minecraft chat formatting codes (e.g. `&l` bold, `&c` red)
\n- `#RRGGBB` \u2014 Inline hex color<\/p>\n
\n|---|---|---|
\n| `timer` | `\"HH:MM:SS\"` | Countdown duration shown at the top |
\n| `timer_pos` | `[x, y]` | Timer position |
\n| `timer_scale` | float | Timer text scale |
\n| `minimize_scale` | `[x, y]` | Scale of the minimized state widget |
\n| `minimize_position` | `[x, y]` | Position of the minimized widget |
\n| `title_pos` | `[x, y]` | Title position |
\n| `title_scale` | float | Title text scale |
\n| `subtitle_pos` | `[x, y]` | Subtitle position |
\n| `subtitle_scale` | float | Subtitle text scale |
\n| `title_controls_pos` | `[x, y]` | Controls section header position |
\n| `title_controls_scale` | float | Controls section header scale |
\n| `controls_pos` | `[x, y]` | Controls list position |
\n| `controls_scale` | float | Controls list text scale |
\n| `title_description_pos` | `[x, y]` | Description section header position |
\n| `title_description_scale` | float | Description section header scale |
\n| `description_pos` | `[x, y]` | Description body position |
\n| `description_scale` | float | Description body text scale |<\/p>\n
\n|---|---|---|
\n| `console_command:` | `console_command: say Hello` | Runs a server command |
\n| `wait:` | `wait: 5s` | Waits the specified time before the next command |<\/p>\n
\n{
\n \"enabled\": false,
\n \"source_lang\": \"es\",
\n \"api_key\": \"\"
\n}
\n```<\/p>\n