noteblock-generator 0.1.8.1

Generate music compositions in Minecraft noteblocks.

Noteblock generator

Generate music in Minecraft noteblocks.

This program is only intended for my own use, and shared only for others to replicate my builds.

See my projects:

• Handel's He trusted in God
• Bach's Sind Blitze, sind Donner
• Bach's Herr, unser Herrscher
• Mozart's Confutatis
• Mozart's Dies irae
• Mozart's Canzonetta sull'aria

Requirements

• Minecraft java 1.19+
• python 3.10+

Installation:

pip install --upgrade noteblock-generator

Do not use git version, it is for development (i.e. myself) only. I cannot guarantee that it is compatible with all of my projects.

Usage

noteblock-generator [-h] [--location [LOCATION ...]] [--orientation [ORIENTATION ...]] [--theme THEME] [--blend] path_in path_out

positional arguments:
  path_in                         path to music source file/folder
  path_out                        path to Minecraft world

options:
  -h, --help                      show this help message and exit
  --location [LOCATION ...]       build location (in x y z); default is ~ ~ ~
  --dimension DIMENSION           build dimension; default is player's dimension
  --orientation [ORIENTATION ...] build orientation (in x y z); default is + + +
  --theme THEME                   opaque block for redstone components; default is stone
  --blend                         blend the structure in with its environment (EXPERIMENTAL)

Path in

Path to a music file, or a folder containing multiple music files.

This program is only intended for my own use, so there is no documentation for writing music files. Follow the build from source instructions in my projects in order to replicate my builds.

Path out

Path to a Minecraft world save folder.

Location

The location where the structure will be generated.

This uses Minecraft's relative coordinates syntax, where ~ stands for the player's location. For example, --location ~ ~ ~ (default) is the player's current location, --location ~ ~10 ~ is 10 blocks above the player, etc.

Notes: In Unix operating systems, ~ is a special character that stands for the home directory, make sure to escape it.

Dimension

The dimension where the structure will be generated.

Valid choices are overworld, the_nether, the_end.

If not given, it will be the player's current dimension.

Orientation

In which direction, from the aforementioned location, the structure will be generated.

--orientation + + + (default) means the structure will be generated towards the positive x, positive y, positive z directions.

All valid orientations are + + +, + + -, + - +, + - -, - + +, - + -, + + +, + + -, + - +, + - -.

Note: Make sure there is enough space in your specified direction in order to generate. The program cannot generate below bedrock, or above the height limit, etc. For example, if you are at y=-64, --location ~ ~ ~ --orientation + - + will not work.

Theme

Choose a block that can conduct redstones for the basis of the structure. Default is stone.

Consult Minecraft's documentation for what blocks can conduct redstone and their technical names (java version).

Blend

By default, the program will clear the entire space before generating. With --blend, it will place noteblocks and redstone components where they need to be and leave the rest as-is.

This is an experimental feature. If the redstones and/or noteblocks don't behave as expected (especially if there is a water source nearby), turn it off.