# lightning-rod
[](https://github.com/reapermc/lightning-rod/actions)
> Function library for the Bolt scripting language.
## Introduction
**Minecraft version: `1.20.1`**
This library features an API for the minecraft commands, usually improved by adding dynamic support or even adding new abstract functions.
```py
from lightning_rod:api import Bossbar, set_level, random
# example of OOP bossbars ^^
bb = Bossbar()
bb.name = 'gas prices'
bb.color = 'red'
bb.show()
# example of dynamic level setting at runtime ^^
set_level(random(5, 20))
```
## Installation
```bash
pip install lightning_rod
```
## Getting started
The library is designed to be used within any `bolt` script (either a `.mcfunction` or `bolt` file) inside a `bolt` enabled project.
```yaml
require:
- bolt
- lightning_rod
pipeline:
- mecha
```
Once you've required `bolt` and `lightning_rod`, you are able to import the package's `api` module directly inside your bolt script.
Most of the imports come from the `lightning_rod:api` module as shown below.
```py
from lightning_rod:api import random, sqrt
```
Now you're free to use the API!
## Documentation
Coming soon...
<!-- Docs available [here](./docs/home.md). -->
---
License - [MIT](https://github.com/reapermc/lightning-rod/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/reapermc/lightning-rod",
"name": "lightning-rod",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.12,<4.0",
"maintainer_email": "",
"keywords": "beet,bolt,minecraft,datapack,minecraft-commands,mcfunction,library,reapermc",
"author": "ArcticYeti",
"author_email": "arcticyeti1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/24/74/47e9037a71ebdcd79f89a53d22fa806ddb41ad054f160743d8c9e8857a97/lightning_rod-1.0.0.tar.gz",
"platform": null,
"description": "# lightning-rod\n\n[](https://github.com/reapermc/lightning-rod/actions)\n\n> Function library for the Bolt scripting language.\n\n\n## Introduction\n\n**Minecraft version: `1.20.1`**\n\nThis library features an API for the minecraft commands, usually improved by adding dynamic support or even adding new abstract functions.\n\n```py\nfrom lightning_rod:api import Bossbar, set_level, random\n\n# example of OOP bossbars ^^\nbb = Bossbar()\n\nbb.name = 'gas prices'\nbb.color = 'red'\n\nbb.show()\n\n# example of dynamic level setting at runtime ^^\nset_level(random(5, 20))\n```\n\n## Installation\n\n```bash\npip install lightning_rod\n```\n\n## Getting started\n\nThe library is designed to be used within any `bolt` script (either a `.mcfunction` or `bolt` file) inside a `bolt` enabled project.\n\n```yaml\nrequire:\n - bolt\n - lightning_rod\n\npipeline:\n - mecha\n```\n\nOnce you've required `bolt` and `lightning_rod`, you are able to import the package's `api` module directly inside your bolt script.\n\nMost of the imports come from the `lightning_rod:api` module as shown below.\n\n```py\nfrom lightning_rod:api import random, sqrt\n```\n\nNow you're free to use the API!\n\n\n## Documentation\n\nComing soon...\n<!-- Docs available [here](./docs/home.md). -->\n\n---\n\nLicense - [MIT](https://github.com/reapermc/lightning-rod/blob/main/LICENSE)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Function library for the Bolt scripting language.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/reapermc/lightning-rod"
},
"split_keywords": [
"beet",
"bolt",
"minecraft",
"datapack",
"minecraft-commands",
"mcfunction",
"library",
"reapermc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58c2b388d7bcbff1398c66454cc844c80fa4c8db95b521d00a63a9516a50f841",
"md5": "0bb333a244f0ea33a99b7c3c2c7c20d3",
"sha256": "00d8b1e18c8b162e0891195a9a0eba4a35ce9f209a789b672877765ab63b6e80"
},
"downloads": -1,
"filename": "lightning_rod-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bb333a244f0ea33a99b7c3c2c7c20d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12,<4.0",
"size": 10316,
"upload_time": "2023-12-03T23:44:41",
"upload_time_iso_8601": "2023-12-03T23:44:41.722763Z",
"url": "https://files.pythonhosted.org/packages/58/c2/b388d7bcbff1398c66454cc844c80fa4c8db95b521d00a63a9516a50f841/lightning_rod-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "247447e9037a71ebdcd79f89a53d22fa806ddb41ad054f160743d8c9e8857a97",
"md5": "92beb98de9a8c5384d3305c7cbfa9fcd",
"sha256": "a6248bce1e8d3ce266c8e2d4a9ddeefd7dea8b9d51989a4b12ef18eb5679f9bb"
},
"downloads": -1,
"filename": "lightning_rod-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "92beb98de9a8c5384d3305c7cbfa9fcd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12,<4.0",
"size": 7073,
"upload_time": "2023-12-03T23:44:43",
"upload_time_iso_8601": "2023-12-03T23:44:43.192302Z",
"url": "https://files.pythonhosted.org/packages/24/74/47e9037a71ebdcd79f89a53d22fa806ddb41ad054f160743d8c9e8857a97/lightning_rod-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-03 23:44:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "reapermc",
"github_project": "lightning-rod",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lightning-rod"
}
JSON
