Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nat1anwastaken/notebot
A mod plays noteblock nicely for you!
https://github.com/nat1anwastaken/notebot
fabric fabric-mod fabricmc fabricmc-mod minecraft minecraft-hack minecraft-mod minecraft-modding minecraft-modification minecraft-modifications minecraft-mods noteblock noteblocks noteblockstudio
Last synced: 3 months ago
JSON representation
A mod plays noteblock nicely for you!
- Host: GitHub
- URL: https://github.com/nat1anwastaken/notebot
- Owner: Nat1anWasTaken
- License: gpl-3.0
- Created: 2023-03-26T05:45:11.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-01T03:06:13.000Z (over 1 year ago)
- Last Synced: 2024-10-14T06:21:39.809Z (3 months ago)
- Topics: fabric, fabric-mod, fabricmc, fabricmc-mod, minecraft, minecraft-hack, minecraft-mod, minecraft-modding, minecraft-modification, minecraft-modifications, minecraft-mods, noteblock, noteblocks, noteblockstudio
- Language: Java
- Homepage: https://l.nat1an.xyz/notebot
- Size: 1.54 MB
- Stars: 19
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GNU General Public License][license-shield]][license-url]
Notebot
A mod plays noteblock nicely for you!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://l.nat1an.xyz/notebot)
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][bleachdev-url] for creating and open-sourcing [BleachHack][bleachhack-url]! That inspired me a lot
and this mod is heavily based on BleachHack's [Notebot][bleachhack-notebot-url] module!
## Getting Started
How to use the mod.
### For Players
Download the latest release from the [Releases][releases-url] 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.
1. Clone the repo
```sh
git clone https://github.com/Nat1anWasTaken/Notebot.git
```
2. Make your changes
3. Run the dev client
```sh
./gradlew runClient
```
4. Build the jar
```sh
./gradlew jar
```
The jar will be in `build/libs/`
## Usage
1. Install the mod, See [Getting Started](#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
## Roadmap
- [x] Queue
- [x] Multi-Instruments support
- [x] Fairplay mode
See the [open issues](https://github.com/Nat1anWasTaken/Notebot/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!
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
## License
Distributed under the GNU General Public License. See `LICENSE` for more information.
## Contact
Discord - [Nat1an#0001](discord://-/users/731146912975159427) - [email protected]
Project Link: [https://github.com/Nat1anWasTaken/Notebot](https://github.com/Nat1anWasTaken/Notebot)
[contributors-shield]: https://img.shields.io/github/contributors/Nat1anWasTaken/Notebot.svg?style=for-the-badge
[contributors-url]: https://github.com/Nat1anWasTaken/Notebot/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Nat1anWasTaken/Notebot.svg?style=for-the-badge
[forks-url]: https://github.com/Nat1anWasTaken/Notebot/network/members
[stars-shield]: https://img.shields.io/github/stars/Nat1anWasTaken/Notebot.svg?style=for-the-badge
[stars-url]: https://github.com/Nat1anWasTaken/Notebot/stargazers
[releases-url]: https://github.com/Nat1anWasTaken/Notebot/releases
[issues-shield]: https://img.shields.io/github/issues/Nat1anWasTaken/Notebot.svg?style=for-the-badge
[issues-url]: https://github.com/Nat1anWasTaken/Notebot/issues
[license-shield]: https://img.shields.io/github/license/Nat1anWasTaken/Notebot?style=for-the-badge
[license-url]: https://github.com/Nat1anWasTaken/Notebot/blob/master/LICENSE
[product-screenshot]: imgs/screenshot.png
[bleachdev-url]: https://github.com/BleachDev
[bleachhack-url]: https://github.com/BleachDev/BleachHack
[bleachhack-notebot-url]: https://github.com/BleachDev/BleachHack/blob/1.19.4/src/main/java/org/bleachhack/module/mods/Notebot.java