# Minecraft Script
Minecraft script is primarily a tool to make Minecraft Datapack creation easier.
Minecraft Script is an interpreted programming language which goes through the Python interpreter for output.
However, interpretation is not its main feature, and is rather more of a debugging tool, as its sole
purpose is to allow you to validate your code before building it into a full datapack.
Be sure to check out the [documentation](https://github.com/Bard-Gaming/Minecraft-Script/tree/main/documentation) and the provided [examples](https://github.com/Bard-Gaming/Minecraft-Script/tree/main/examples)!
## Installation
MCS can be installed using [Python's pip module](https://pip.pypa.io/en/stable/installation/).
```commandline
pip install minecraft-script
```
or
```commandline
python -m pip install minecraft-script
```
_Note: The package's name in pip is written with a hyphen ``-``,
whilst the actual Python package is written with an underscore ``_``._
## Using Minecraft Script to make Datapacks
### Debugging your program
To debug your program, you can first run your file like any other programming language.
To do this, use the following command:
```commandline
python -m minecraft_script debug <path>
```
_where <path> is a relative or absolute path to your mcs file_
### Building your datapack
To actually build your minecraft datapack, which you can then simply drag & drop into your
minecraft worlds, use the following command:
```commandline
python -m minecraft_script compile <path>
```
_where <path> is a relative or absolute path to your mcs file_
### More info
For a list of all shell commands, you can use the following command:
```commandline
python -m minecraft_script help
```
If you want to simplify the usage of shell commands, you can check out [the installations page in the documentation](https://github.com/Bard-Gaming/Minecraft-Script/blob/main/documentation/custom-installations.md).
## GitHub
[**Link to GitHub Repository**](https://github.com/Bard-Gaming/Minecraft-Script)
Source code, documentation, and examples, can all be found on the GitHub.
## Compatibility
This python package **does not work on Linux / macOS**.
Raw data
{
"_id": null,
"home_page": null,
"name": "minecraft-script",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "minecraft, mc, script, language",
"author": "Joyful-Bard",
"author_email": "<christophe@dronne.fr>",
"download_url": "https://files.pythonhosted.org/packages/51/0d/b979225bf87d0c10eac27b2b2916fb8e154ab46a937ff7a98f4124ab6939/minecraft_script-0.2.2.tar.gz",
"platform": null,
"description": "\r\n# Minecraft Script\r\n\r\n\r\n\r\nMinecraft script is primarily a tool to make Minecraft Datapack creation easier.\r\n\r\nMinecraft Script is an interpreted programming language which goes through the Python interpreter for output.\r\n\r\nHowever, interpretation is not its main feature, and is rather more of a debugging tool, as its sole\r\n\r\npurpose is to allow you to validate your code before building it into a full datapack.\r\n\r\n\r\n\r\nBe sure to check out the [documentation](https://github.com/Bard-Gaming/Minecraft-Script/tree/main/documentation) and the provided [examples](https://github.com/Bard-Gaming/Minecraft-Script/tree/main/examples)!\r\n\r\n\r\n\r\n## Installation\r\n\r\nMCS can be installed using [Python's pip module](https://pip.pypa.io/en/stable/installation/).\r\n\r\n\r\n\r\n```commandline\r\n\r\npip install minecraft-script\r\n\r\n```\r\n\r\nor\r\n\r\n```commandline\r\n\r\npython -m pip install minecraft-script\r\n\r\n```\r\n\r\n_Note: The package's name in pip is written with a hyphen ``-``,\r\n\r\nwhilst the actual Python package is written with an underscore ``_``._\r\n\r\n\r\n\r\n\r\n\r\n## Using Minecraft Script to make Datapacks\r\n\r\n### Debugging your program\r\n\r\nTo debug your program, you can first run your file like any other programming language.\r\n\r\nTo do this, use the following command:\r\n\r\n```commandline\r\n\r\npython -m minecraft_script debug <path>\r\n\r\n```\r\n\r\n_where <path> is a relative or absolute path to your mcs file_\r\n\r\n\r\n\r\n### Building your datapack\r\n\r\nTo actually build your minecraft datapack, which you can then simply drag & drop into your\r\n\r\nminecraft worlds, use the following command:\r\n\r\n```commandline\r\n\r\npython -m minecraft_script compile <path>\r\n\r\n```\r\n\r\n_where <path> is a relative or absolute path to your mcs file_\r\n\r\n\r\n\r\n### More info\r\n\r\nFor a list of all shell commands, you can use the following command:\r\n\r\n```commandline\r\n\r\npython -m minecraft_script help\r\n\r\n```\r\n\r\nIf you want to simplify the usage of shell commands, you can check out [the installations page in the documentation](https://github.com/Bard-Gaming/Minecraft-Script/blob/main/documentation/custom-installations.md).\r\n\r\n\r\n\r\n## GitHub\r\n\r\n[**Link to GitHub Repository**](https://github.com/Bard-Gaming/Minecraft-Script)\r\n\r\n\r\n\r\nSource code, documentation, and examples, can all be found on the GitHub.\r\n\r\n\r\n\r\n## Compatibility\r\n\r\nThis python package **does not work on Linux / macOS**.\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Minecraft Script Programming language",
"version": "0.2.2",
"project_urls": null,
"split_keywords": [
"minecraft",
" mc",
" script",
" language"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b18136c4fa69b99ace29bf11a2e18097937cdd263d5697deb572f34110e8a5d6",
"md5": "c0bc6ba4090e9b5f5daa1871b09de05e",
"sha256": "44fd2fdbc3383648b7bf20c9635b277ef407aa8ff1762cacb4c9c320410257c7"
},
"downloads": -1,
"filename": "minecraft_script-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0bc6ba4090e9b5f5daa1871b09de05e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 43121,
"upload_time": "2024-06-10T22:01:02",
"upload_time_iso_8601": "2024-06-10T22:01:02.981433Z",
"url": "https://files.pythonhosted.org/packages/b1/81/36c4fa69b99ace29bf11a2e18097937cdd263d5697deb572f34110e8a5d6/minecraft_script-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "510db979225bf87d0c10eac27b2b2916fb8e154ab46a937ff7a98f4124ab6939",
"md5": "7e0c5b4f1f40de2cf3588e60d37fbef0",
"sha256": "612d097b6a2f7dd6997425e95a5a04f5f66fb7a5e9b2b2f6229f971c4770550e"
},
"downloads": -1,
"filename": "minecraft_script-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "7e0c5b4f1f40de2cf3588e60d37fbef0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32971,
"upload_time": "2024-06-10T22:01:05",
"upload_time_iso_8601": "2024-06-10T22:01:05.048358Z",
"url": "https://files.pythonhosted.org/packages/51/0d/b979225bf87d0c10eac27b2b2916fb8e154ab46a937ff7a98f4124ab6939/minecraft_script-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-10 22:01:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "minecraft-script"
}
JSON