NoteBot Mod Feature Overview

NoteBot is a client-side mod for Fabric designed to automate Note Block operations and play music within Minecraft. It loads external song files and automatically tunes and plays surrounding Note Blocks.

1. Song Playback Features

Load and play music data within the game from external files.

Supported File Formats:
- .nbs: Direct support for Minecraft Note Block Studio files.
- .txt: Proprietary text-based song data.
Playback Control: Select, play, pause, and stop songs via a dedicated GUI (NotebotScreen).
Playback Modes:
- Tick-based Synchronization: Plays with precise timing synchronized to Minecraft's in-game ticks.
- Preview Function: Play sounds only on the client side to check the song without interacting with actual Note Blocks.

2. Note Block Management (Stage System)

Automatically finds and manages the Note Blocks required for performance.

Area Scanning: Automatically searches for Note Blocks around the player and lists them as available instruments.
Auto-Instrument Detection: Identifies the type of instrument (Harp, Bass Drum, Snare, etc.) based on the block positioned underneath the Note Block.
Auto-Tuning: Automatically tunes surrounding Note Blocks to the required pitch by simulating right-click operations.

3. Visual Feedback (Rendering)

Provides visual cues for the performance status and block conditions.

World Rendering: Highlights blocks in the world that require tuning or are currently being played.
HUD Display: Shows real-time playback status, elapsed time, and any missing instruments directly on the screen.
Debug View: Detailed technical status and scan results for troubleshooting.

4. Configuration Options (NotebotSettings)

Customize the behavior to suit your preferences.

Playing Mode: Configure movements during performance, such as facing the block (LOOK) or showing the arm-swing animation (SWING).
Playback Speed Adjustment: Adjust the tempo of the song.
Volume Settings: Balance the audio levels specifically for sounds played through the mod.

5. Technical Highlights

Mixin Integration: Hooks into ChatScreen, InGameHud, Network Handlers, and Debug Renderers to extend vanilla behavior.
Localization Support: Supports six languages: Japanese (JA), English (EN), German (DE), French (FR), Russian (RU), and Chinese (ZH).
ModMenu Compatibility: Allows direct access to the configuration screen if ModMenu is installed.

How to Use (Estimated)

Open the Notebot GUI using the designated key (likely N by default or via the settings menu).
Select a music file from the song list.
Use "Scan" or "Setup" to register surrounding Note Blocks as instruments.
Press "Play." The mod will automatically perform necessary tuning before starting the performance.

Note Bot