InstructionsPlix

 Instructions Plix

Instructions Plix is a mod for Fabric (Minecraft 1.21.1) that allows server administrators to create and display custom instruction screens for players. Ideal for tutorials, game guides, server rules, or any information you need to display in a visual and interactive way.

 Key Features

Customizable Visual Design

Titles, subtitles, and text in different sizes and styles

Customizable images: use them as backgrounds or decorative elements

Mini-viewport: displays the game in real time in a window within the screen

Free positioning: drag and drop each element wherever you want

Resizing: easily adjust the size of images and the mini-viewport

 Automatic Timer

Set how long each screen remains active (e.g., 30 seconds, 2 minutes, etc.)

When the time runs out, the screen closes automatically

Option for screens without a timer (closed manually)

 Asset System

Upload images to the server from config/instructions-plix/assets/

The server automatically sends the images to clients

Smart cache to avoid re-downloading assets that have already been viewed

Optimized User Experience

Smooth transitions: fade in/out

Visible cursor: allows for easy interaction with the interface

Movement locked: the player cannot move while viewing the screen

Fixed camera: the view cannot be rotated during display

Accessible chat: players can open the chat if needed

No hotbar: the vanilla interface is hidden for greater immersion

 Commands

For Administrators

/inst menu - Opens the screen design menu

/inst <id> - Activates a saved screen (visible to the player who executes the command)

/inst <id> <player> - Activates a screen for a specific player

/inst quit - Immediately closes the active screen

In the Design Menu (/inst menu)

Create New Screen: Design from scratch

Edit: Modify existing screens

Add Elements:

+ Title - Large, highlighted text

+ Subtitle - Medium-sized text

+ Text - Normal text

+ Timer - Visual element that displays the remaining time

Assets - Select images from the server

Timer - Set the duration

Save: Sends the design to the server

Drag and drop: Move elements by left-clicking

Resize: Drag the lower-right corner

Delete: Right-click on any element

 Requirements

Minecraft: 1.21.1

Mod Loader: Fabric

Dependencies:

Fabric API (required)

 Installation

On the Server

Install Fabric Server for Minecraft 1.21.1

Add Fabric API to the mods/ folder

Add Instructions Plix to the mods/ folder

Start the server

Add images to config/instructions-plix/assets/ (optional)

On the Client

Install Fabric Loader for Minecraft 1.21.1

Add the Fabric API to the mods/ folder

Add Instructions Plix to the mods/ folder

Launch Minecraft

 Use Cases

 Game Tutorials: Teach players new mechanics

 Server Rules: Display the rules upon joining

️ Building Guides: Explain how to build structures

 Missions/Objectives: Instructions for quests or challenges

 Important Announcements: Temporary information for all players

️ For Developers

The mod uses a client-server architecture:

Server: Stores screens and assets, sends data to clients

Client: Renders screens locally with smooth transitions

Network: Efficient communication via custom payloads

Notes

Screens are saved on the server and persist across restarts

Players need the mod installed to view the screens

Images are automatically compressed when sent to the client

Support for multiple simultaneous screens (one per player)

Translated with DeepL.com (free version)