FFCraft

A powerful Minecraft Java Edition media playback mod that allows you to play any media content in your world, supports custom-shaped screens, and is fully compatible with shaders.

✨ Features

• Full-format media playback — Based on FFmpeg, supports almost all audio and video formats.
• Arbitrary-shaped screens — Build polygonal display areas by placing vertices, supporting up to 64 vertices.
• Perfect shader compatibility — Screens correctly reflect and respond to shader pack lighting effects for natural display.
• Convenient GUI management — Press the G key by default to open the graphical interface for easy creation, configuration, and deletion of players.
• Comprehensive command system — Provides a full set of commands for administrator and player interaction.
• High-performance decoding — Ensures smooth playback of high-resolution videos.

🛠 Tech Stack & Dependencies

• Mod Framework: Fabric
• Language: Java
• Media Engine: FFmpeg
• Required Mod: ImGui (must be installed)

📥 Installation

For Regular Players

1. Make sure you have installed Fabric Loader and Fabric API.
2. Install the required mod ImGui.
3. Install the required mod DrawLib
4. Go to the Releases page.
5. Download the latest build .jar file for your game version.
6. Place it into Minecraft's mods folder.
7. Launch the game.

For Developers

git clone https://github.com/Sashwind888/FFCraft.git
cd FFCraft
./gradlew build

The build output is located in build/libs/.

For Special Instruction Set Users

1. After cloning the repository, edit build.gradle.
2. Add the FFmpeg dependency that matches your platform architecture.
3. Run:

   ./gradlew jar
   

🚀 Quick Start

1. After entering the game, press the G key to open the FFCraft management GUI.
2. In the GUI, click "Create Player", then click "Create Screen".
3. Right-click to place the screen's vertices (up to 64), left-click to cancel the last vertex, and click the starting point to complete the polygon creation.
4. Assign a name to the player and choose its public/private status.
5. In the player interface, load a media file or enter a stream URL to start playback.

📋 Command System

Command	Permission	Description
/ffcraft create <name> [public|private]	Admin	Create a player
/ffcraft list	Everyone	List all players
/ffcraft info <uuid>	Everyone	View player details
/ffcraft rename <uuid> <newName>	Edit	Rename a player
/ffcraft delete <uuid>	Admin	Delete a player
/ffcraft setpublic <uuid> <true|false>	Admin	Set public status
/ffcraft reload	Admin	Resync all clients

• Permission nodes: ffcraft.admin, ffcraft.edit, etc. (configured according to your server's permission plugin).
• All uuid parameters refer to the unique identifier of the player.

🤝 Contributing

Issues and Pull Requests are welcome to help improve FFCraft!

📄 License

This project is licensed under the AGPLv3 license. You are free to use, modify, and distribute it, but modified versions must also be open-sourced under the same license. For details, see the LICENSE file.

---

Hope this project helps you, meow~ --sashwind Plugin version: Modrinth