# Noteblock generator
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](https://github.com/FelixFourcolor/He-trusted-in-God)
* [Bach's Sind Blitze, sind Donner](https://github.com/FelixFourcolor/Sind-Blitze-sind-Donner)
* [Bach's Herr, unser Herrscher](https://github.com/FelixFourcolor/Herr-unser-Herrscher)
* [Mozart's Confutatis](https://github.com/FelixFourcolor/Confutatis)
* [Mozart's Dies irae](https://github.com/FelixFourcolor/Dies-irae)
* [Mozart's Sull'aria](https://github.com/FelixFourcolor/Canzonetta-sull-aria)
* [Handel's And the glory of the Lord](https://github.com/FelixFourcolor/And-the-glory-of-the-Lord)
* [Handel's Hallelujah](https://github.com/FelixFourcolor/Hallelujah)
## Requirements
* Minecraft Java 1.19+
* Python 3.10-3.12
## Installation
```pip install --upgrade noteblock-generator```
## Usage
```text
usage: noteblock-generator path/to/music/source path/to/minecraft/world [OPTIONS]
build options:
-l/--location X Y Z build location; default is player's location
-d/--dimension DIMENSION build dimension; default is player's dimension
-o/--orientation HORIZONTAL VERTICAL build orientation; default is player's orientation
-t/--theme BLOCK redstone-conductive block; default is stone
--blend blend the structure with its environment
output options:
-q/--quiet decrease output verbosity; can be used up to 3 times
--debug show full exception traceback if an error occurs
help:
-h/--help show this help message and exit
```
### Music source
Path to the music source. It should be provided to you in all of my projects.
### Minecraft world
Path to an existing minecraft world. Only Java Edition is supported.
Consult Minecraft's documentation (or your custom launcher's documentation if you use one) for where the save folder is.
### 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.
### Dimension
The dimension where the structure will be generated. If not given, it will be the player's current dimension.
### Orientation
The orientation towards which the structure will be generated.
This uses Minecraft's rotation syntax, which is a pair of two numbers, the first one for horizontal, the second one for vertical. Horizontal rotation goes from -180 to 180, where -180 is north, -90 is east, 0 is south, 90 is east, and 180 is wrapping back to north. Vertical rotation goes form -90 to 90, where -90 is looking straight up and 90 is straight down.
Similarly to location, either value of the pair (or both) can be substituted with a `~` to use the player's current orientation. For example, `--orientation ~ 90` means facing the same horizontal direction as the player, looking down.
### Theme
Choose a block that can conduct redstones. Default is `stone`
Consult Minecraft's documentation for what blocks can conduct redstone and their technical names (Java Edition).
### 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, remove things that may interfere with the redstones (e.g. water), and leave the rest. The result is the structure will appear blended in with its environment.
### Verbosity
There are 4 verbosity levels, from least to most verbose is:
* `-qqq`: No output at all, even if an error occurs, only an exit status to indicate success.
* `-qq`: Above, plus critical warnings, and a brief error message if one occurs.
* `-q`: Above, plus brief information about the structure, a generating progress bar, and longer error message if one occurs.
* Default: Above, plus full information about the structure, and a confirmation prompt before generating.
Note: with `-q` option, without a confirmation prompt, you can still press `CTRL + C` before the progress bar reaches 100% to safely quit the program; no changes would be made to the world.
Raw data
{
"_id": null,
"home_page": "https://www.youtube.com/@felixfourcolor",
"name": "noteblock-generator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<3.13",
"maintainer_email": "",
"keywords": "minecraft,noteblock",
"author": "Felix Fourcolor",
"author_email": "felix.fourcolor@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fb/60/5bab1d17bb1cc92ced7dbbe18292b03d1313c625cef8708156e8b26f2578/noteblock_generator-0.2.1.tar.gz",
"platform": null,
"description": "# Noteblock generator\n\nThis program is only intended for my own use, and shared only for others to replicate my builds.\n\nSee my projects:\n\n* [Handel's He trusted in God](https://github.com/FelixFourcolor/He-trusted-in-God)\n* [Bach's Sind Blitze, sind Donner](https://github.com/FelixFourcolor/Sind-Blitze-sind-Donner)\n* [Bach's Herr, unser Herrscher](https://github.com/FelixFourcolor/Herr-unser-Herrscher)\n* [Mozart's Confutatis](https://github.com/FelixFourcolor/Confutatis)\n* [Mozart's Dies irae](https://github.com/FelixFourcolor/Dies-irae)\n* [Mozart's Sull'aria](https://github.com/FelixFourcolor/Canzonetta-sull-aria)\n* [Handel's And the glory of the Lord](https://github.com/FelixFourcolor/And-the-glory-of-the-Lord)\n* [Handel's Hallelujah](https://github.com/FelixFourcolor/Hallelujah)\n\n## Requirements\n\n* Minecraft Java 1.19+\n* Python 3.10-3.12\n\n## Installation\n\n```pip install --upgrade noteblock-generator```\n\n## Usage\n\n```text\nusage: noteblock-generator path/to/music/source path/to/minecraft/world [OPTIONS]\n\nbuild options:\n -l/--location X Y Z build location; default is player's location\n -d/--dimension DIMENSION build dimension; default is player's dimension\n -o/--orientation HORIZONTAL VERTICAL build orientation; default is player's orientation\n -t/--theme BLOCK redstone-conductive block; default is stone\n --blend blend the structure with its environment\n\noutput options:\n -q/--quiet decrease output verbosity; can be used up to 3 times\n --debug show full exception traceback if an error occurs\n\nhelp:\n -h/--help show this help message and exit\n```\n\n### Music source\n\nPath to the music source. It should be provided to you in all of my projects.\n\n### Minecraft world\n\nPath to an existing minecraft world. Only Java Edition is supported.\n\nConsult Minecraft's documentation (or your custom launcher's documentation if you use one) for where the save folder is.\n\n### Location\n\nThe location where the structure will be generated.\n\nThis 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.\n\n### Dimension\n\nThe dimension where the structure will be generated. If not given, it will be the player's current dimension.\n\n### Orientation\n\nThe orientation towards which the structure will be generated.\n\nThis uses Minecraft's rotation syntax, which is a pair of two numbers, the first one for horizontal, the second one for vertical. Horizontal rotation goes from -180 to 180, where -180 is north, -90 is east, 0 is south, 90 is east, and 180 is wrapping back to north. Vertical rotation goes form -90 to 90, where -90 is looking straight up and 90 is straight down.\n\nSimilarly to location, either value of the pair (or both) can be substituted with a `~` to use the player's current orientation. For example, `--orientation ~ 90` means facing the same horizontal direction as the player, looking down.\n\n### Theme\n\nChoose a block that can conduct redstones. Default is `stone`\n\nConsult Minecraft's documentation for what blocks can conduct redstone and their technical names (Java Edition).\n\n### Blend\n\nBy default, the program will clear the entire space before generating. With `--blend`, it will place noteblocks and redstone components where they need to be, remove things that may interfere with the redstones (e.g. water), and leave the rest. The result is the structure will appear blended in with its environment.\n\n### Verbosity\n\nThere are 4 verbosity levels, from least to most verbose is:\n\n* `-qqq`: No output at all, even if an error occurs, only an exit status to indicate success.\n* `-qq`: Above, plus critical warnings, and a brief error message if one occurs.\n* `-q`: Above, plus brief information about the structure, a generating progress bar, and longer error message if one occurs.\n* Default: Above, plus full information about the structure, and a confirmation prompt before generating.\n\nNote: with `-q` option, without a confirmation prompt, you can still press `CTRL + C` before the progress bar reaches 100% to safely quit the program; no changes would be made to the world.\n",
"bugtrack_url": null,
"license": "CC0-1.0",
"summary": "Generate music compositions in Minecraft noteblocks",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://www.youtube.com/@felixfourcolor",
"Repository": "https://github.com/FelixFourcolor/noteblock-generator"
},
"split_keywords": [
"minecraft",
"noteblock"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3646e96e37dd71a66b8392b1f23d9048ec173f2d9af55a86e4cd40e75b092d6",
"md5": "262282c538230b0bfba97bba97f26df2",
"sha256": "8570ac03a0c7c4e0114c3ea116ed357571638e2d1d3d89a4f152310ffb358901"
},
"downloads": -1,
"filename": "noteblock_generator-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "262282c538230b0bfba97bba97f26df2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.13",
"size": 25820,
"upload_time": "2023-12-29T01:24:28",
"upload_time_iso_8601": "2023-12-29T01:24:28.028106Z",
"url": "https://files.pythonhosted.org/packages/e3/64/6e96e37dd71a66b8392b1f23d9048ec173f2d9af55a86e4cd40e75b092d6/noteblock_generator-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb605bab1d17bb1cc92ced7dbbe18292b03d1313c625cef8708156e8b26f2578",
"md5": "69eeb1aefba872008457bb177dab360a",
"sha256": "c7defdbbdcf04906eb82ed5f3448281650050e0032d4d5fde45fdaa3cd584789"
},
"downloads": -1,
"filename": "noteblock_generator-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "69eeb1aefba872008457bb177dab360a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.13",
"size": 24645,
"upload_time": "2023-12-29T01:24:29",
"upload_time_iso_8601": "2023-12-29T01:24:29.564272Z",
"url": "https://files.pythonhosted.org/packages/fb/60/5bab1d17bb1cc92ced7dbbe18292b03d1313c625cef8708156e8b26f2578/noteblock_generator-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-29 01:24:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FelixFourcolor",
"github_project": "noteblock-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "noteblock-generator"
}
JSON
