Skip to content

reapermc/lightning-rod

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lightning-rod

GitHub 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.

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

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.

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.

from lightning_rod:api import random, sqrt

Now you're free to use the API!

Documentation

Coming soon...


License - MIT