Setsumeisho

# 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

1. Place the mod JAR in the `mods/` folder. 2. 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 ` | Opens the named instruction screen for the executing player | | `/setsumeisho open ` | Opens the instruction screen for a specific player | | `/setsumeisho close` | Closes the currently open instruction overlay | | `/setsumeisho create ` | Creates a new template JSON file at `config/setsumeisho/.json` | | `/setsumeisho pretranslate ` | 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

```json [ { "lang": "es", "title": "TÍTULO", "subtitle": "Subtítulo", "title_controls": "Controles Especiales", "title_description": "Instrucciones", "controls": [ "[] Descripción del control.", "[] Otro control." ], "description": "Descripción del objetivo del minijuego." }, { "lang": "en", "title": "TITLE", "subtitle": "Subtitle", "title_controls": "Special Controls", "title_description": "Instructions", "controls": [ "[] Control description.", "[] Another control." ], "description": "Minigame objective description." }, { "config": { "timer": "00:00:10", "minimize_scale": , "minimize_position": , "title_pos": , "subtitle_pos": , "title_controls_pos": , "controls_pos": , "title_description_pos": , "description_pos": , "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": , "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 `[]` placeholders and `\n` line breaks | | `title_description` | Section header for the description block | | `description` | Body text for the description section |

### Icon placeholders

Use `[]` inside `controls` or `description` strings to embed keyboard/mouse icons. Examples:

• `[]`
• `[]`
• `[]`
• `[]`
• `[]`, `[]`, `[]`, `[]`

### Text formatting

Inside any text field you can use: - `&` — Minecraft chat formatting codes (e.g. `&l` bold, `&c` red) - `#RRGGBB` — Inline hex color

### Config block

All position values are normalized screen coordinates `` 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` | `` | Timer position | | `timer_scale` | float | Timer text scale | | `minimize_scale` | `` | Scale of the minimized state widget | | `minimize_position` | `` | Position of the minimized widget | | `title_pos` | `` | Title position | | `title_scale` | float | Title text scale | | `subtitle_pos` | `` | Subtitle position | | `subtitle_scale` | float |