Open Source Ecosystems

About The Project

I made this mod to learn how to make Minecraft mods. It's a client-side mod that 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!

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.

Clone the repo

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

Make your changes
Run the dev client
```
./gradlew runClient 
```
Build the jar
```
./gradlew jar 
```

The jar will be in build/libs/

Usage

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

Roadmap

Queue
Multi-Instruments support
Fairplay mode

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

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!