My fork of Harry Zhou's SongPlayer
Find a file
2022-07-04 18:45:06 -05:00
src/main Changed currentCommand to statusCommand for consistency 2022-07-04 18:45:06 -05:00
.gitignore Updated to 1.18 2022-03-12 17:06:35 -06:00
build.gradle Updated to 1.18 2022-03-12 17:06:35 -06:00
gradle.properties Incremented version 2022-07-04 11:28:58 -05:00
gradlew Updated to 1.18 2022-03-12 17:06:35 -06:00
gradlew.bat Updated to 1.18 2022-03-12 17:06:35 -06:00
README.md Updated to 1.18 2022-03-12 17:06:35 -06:00
settings.gradle Made playurl ignore certificates 2021-06-23 12:29:10 -05:00

SongPlayer

A Fabric mod for Minecraft that plays noteblocks. The current version is for Minecraft 1.18.x.

How to use

You can grab the jar from releases.

This mod requires fabric api.

Adding songs

You can put midis in the .minecraft/songs folder.

Using the client

All the commands are case insensitive.

$help

Lists commands

$help <command>

Explains a command and shows the command usage.

$play <file name>

Plays a particular midi from the .minecraft/songs folder.

$playurl <url>

Plays a midi from a particular url. The url should be a direct download link to a midi.

$stop

Stops playing/building

$goto <mm:ss>

Goes to a specific time in the song.

$loop

Toggles song looping.

$current

Gets the current song that is playing.

$songs

Lists the songs in your .minecraft/songs folder.

$setCreativeCommand <command>

By default, the client uses /gmc to go into creative mode. However, /gmc does not work on all servers. If the creative command is different, set it with this command. For example, if the server uses vanilla commands, do $setCreativeCommand /gamemode creative.

$setSurvivalCommand <command>

By default, the client uses /gms to go into survival mode. However, /gms does not work on all servers. If the survival command is different, set it with this command. For example, if the server uses vanilla commands, do $setSurvivalCommand /gamemode survival.

$toggleFakePlayer

Toggles whether a fake player will show up to represent your true position while playing a song. When playing a song, since it automatically enables freecam, your true position will be different from your apparent position. The fake player will show where you actually are. By default, this is disabled.

Mechanism

SongPlayer places noteblocks with nbt and instrument data already in them, so the noteblocks do not need to be individually tuned. Ayunami2000 has previously done a proof-of-concept of this method.

My client will automatically detect what noteblocks are needed and place them automatically before each song is played, which makes playing songs quite easy. The only drawback is that you need to be able to switch between creative and survival mode, which my client will attempt to do automatically.

When playing a song, freecam is enabled. You will be able to move around freely, but in reality you are only moving your camera while your player stays at the center of the noteblocks. This is because noteblocks can only be played if you're within reach distance of them, so you have to stand at the center of the noteblocks to play them, but it's still nice to be able to move around while your song is playing.