# ReaperMC
[](https://github.com/reapermc/reapermc/actions)
> A high level framework for the Bolt scripting language.
## Introduction
Reaper is a framework for the [Bolt](https://github.com/mcbeet/bolt) scripting language. It features complex yet optimized, high level yet simple to use functions.
The goal of this project is to reduce the time developers waste. The aim is to enable developers in creating things faster while focusing on the important bits.
For further info about the project, check [here](about.md).
## Installation
```bash
pip install reapermc
```
## Getting started
This package is designed to be used within `.bolt` scripts, inside a bolt enabled project. I will never officially support `.mcfunction` files.
To enable Reaper inside your project, you will need to add `reapermc` to your `require` list inside the beet config file.
```yaml
require:
- bolt
- reapermc
```
Modules named `<namespace>:main` will automatically be the entrypoint.
To use Reaper's functions, you'll need to import them. (**This won't be necessary in the future**).
```py
# my_project:main
from reapermc:api import sleep, set_time, tag
def become_wizard():
tellraw @s 'You will become a wizard...'
with sleep(40):
set_time(13000)
tag('wizardman')
tellraw @s 'You are now a wizard!'
```
# Documentation
The documentation for this project can be found [here](docs/table_of_contents.md).
---
License - [MIT](https://github.com/reapermc/reapermc/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/reapermc/reapermc",
"name": "reapermc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "beet,bolt,minecraft,minecraft-commands,mcfunction,framework,library,reaper,reapermc",
"author": "Yeti",
"author_email": "arcticyeti1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f3/00/d7fae0d30dd56a00113146ce1de14ee4074424677f8654ff299a3a4ae36d/reapermc-1.5.1.tar.gz",
"platform": null,
"description": "# ReaperMC\n[](https://github.com/reapermc/reapermc/actions)\n\n> A high level framework for the Bolt scripting language.\n\n\n\n\n## Introduction\n\nReaper is a framework for the [Bolt](https://github.com/mcbeet/bolt) scripting language. It features complex yet optimized, high level yet simple to use functions.\n\n\nThe goal of this project is to reduce the time developers waste. The aim is to enable developers in creating things faster while focusing on the important bits.\n\nFor further info about the project, check [here](about.md).\n\n## Installation\n\n```bash\npip install reapermc\n```\n\n\n\n## Getting started\n\nThis package is designed to be used within `.bolt` scripts, inside a bolt enabled project. I will never officially support `.mcfunction` files.\n\nTo enable Reaper inside your project, you will need to add `reapermc` to your `require` list inside the beet config file.\n```yaml\nrequire:\n - bolt\n - reapermc\n```\n\n\n\nModules named `<namespace>:main` will automatically be the entrypoint.\n\nTo use Reaper's functions, you'll need to import them. (**This won't be necessary in the future**).\n\n```py\n# my_project:main\n\nfrom reapermc:api import sleep, set_time, tag\n\ndef become_wizard():\n tellraw @s 'You will become a wizard...'\n\n with sleep(40):\n set_time(13000)\n tag('wizardman')\n tellraw @s 'You are now a wizard!'\n```\n\n\n# Documentation\n\nThe documentation for this project can be found [here](docs/table_of_contents.md).\n\n\n\n---\n\nLicense - [MIT](https://github.com/reapermc/reapermc/blob/main/LICENSE)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A high level framework for the Bolt scripting language.",
"version": "1.5.1",
"split_keywords": [
"beet",
"bolt",
"minecraft",
"minecraft-commands",
"mcfunction",
"framework",
"library",
"reaper",
"reapermc"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "a7eedaa92ae4c2fb1d44d34224784eed",
"sha256": "ba49e6baeca829c7c542a5e00d5cb0ba1dcf1f4fba0c2f29f6039c690f0db257"
},
"downloads": -1,
"filename": "reapermc-1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7eedaa92ae4c2fb1d44d34224784eed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 41105,
"upload_time": "2022-12-14T10:14:49",
"upload_time_iso_8601": "2022-12-14T10:14:49.070937Z",
"url": "https://files.pythonhosted.org/packages/aa/ae/253abc8a9ad41e7582b83971dcf01a231d3ff5ebf3a020b7412bd8d353b3/reapermc-1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "ad25d66b685af6b0c79c0af987beb78e",
"sha256": "6f1c4ed2c929aa94b97d31658f699f9722e34adad6b550c2c8a01f25167cc78c"
},
"downloads": -1,
"filename": "reapermc-1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "ad25d66b685af6b0c79c0af987beb78e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 22617,
"upload_time": "2022-12-14T10:14:51",
"upload_time_iso_8601": "2022-12-14T10:14:51.312883Z",
"url": "https://files.pythonhosted.org/packages/f3/00/d7fae0d30dd56a00113146ce1de14ee4074424677f8654ff299a3a4ae36d/reapermc-1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-14 10:14:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "reapermc",
"github_project": "reapermc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "reapermc"
}
JSON
