Notebot

A mod plays noteblock nicely for you!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   Special Thanks
2. Getting Started
   • For Players
   • For Developers
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

A mod plays noteblock nicely for you!

Special Thanks

Thanks BleachDev for creating and open-sourcing BleachHack! That inspired me a lot and this mod is heavily based on BleachHack's Notebot module!

(back to top)

Getting Started

How to use the mod.

For Players

Download the latest release from the Releases page and put it in your mods' folder.

For Developers

If you want to contribute to the project, you can clone the repository and build it yourself.

Requirements:

• JDK 21 installed and selected (Minecraft 1.20.5+ runs on Java 21)

1. Clone the repo

   git clone https://github.com/Nat1anWasTaken/Notebot.git

2. Make your changes
3. Run the dev client

   ./gradlew runClient

4. Build the jar

   ./gradlew jar

The jar will be in build/libs/

Code Style

This project uses Google Java Format via Spotless.

• Format code: ./gradlew spotlessApply
• Check formatting: ./gradlew spotlessCheck

CI runs spotlessCheck and fails if formatting is not compliant.

(back to top)

Usage

1. Install the mod, See Getting Started
2. Put .nbs files in the notebot/songs folder, Note that .txt and .midi files are also supported
3. Launch the game and join a world. This is a client-side mod, so you can use it both in singleplayer and multiplayer
4. Do /notebot queue add {song} to add your song into the queue
5. Do /notebot start to start playing the song

(back to top)

Roadmap

• Queue
• Multi-Instruments support
• Fairplay mode

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License. See LICENSE for more information.

(back to top)

Contact

Discord - Nat1an#0001 - [email protected]

Project Link: https://github.com/Nat1anWasTaken/Notebot

(back to top)