https://github.com/aaravmalani/powerengine
A library which calculates signals and electricity.
https://github.com/aaravmalani/powerengine
electricity engine python
Last synced: 6 months ago
JSON representation
A library which calculates signals and electricity.
- Host: GitHub
- URL: https://github.com/aaravmalani/powerengine
- Owner: AaravMalani
- License: mit
- Created: 2023-09-16T08:31:55.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-16T08:32:30.000Z (about 2 years ago)
- Last Synced: 2025-03-16T21:37:45.305Z (7 months ago)
- Topics: electricity, engine, python
- Language: Python
- Homepage:
- Size: 4.88 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PowerEngine: A library which calculates signals and electricity.
## Installation
```sh
python -m pip install powerengine
# OR
python -m pip install git+https://github.com/AaravMalani/powerengine
```
## Usage
```py
from powerengine import Engine
engine = Engine()
engine.add_blocks([
Power(engine, {}, (0, 0, 0)),
Wire(engine, {'facing': None}, (0, 0, 1)),
Wire(engine, {'facing': None}, (0, 0, 2)),
Delayer(engine, {'facing': 'east', 'delay': 5}, (0, 0, 3)),
Wire(engine, {'facing': None}, (0, 0, 4)),
])
engine.run(3, ignore_speed=True, output=False)
```
## Plugin Structure
Each plugin is a directory in the `installation/path/plugins` directory.
It contains a `manifest.json` JSON file with the following fields.
| Field | Type | Description |
| ----------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| name | `string` | Plugin name |
| version | `string` | Plugin version |
| author (optional) | `string` or `array[string]` | The author of the plugin |
| blockTypes | `object[string, array[string]]` | An object of the screaming snake case version of the name to the block types defined (each block type being an array of `[namespace, id]`) |
A plugin is a Python module (it has an `__init__.py`)
An example plugin would be
`main.py`
```py
import powerengine
class PizzaBlock(powerengine.Block):
id = ('pizzamod', 'pizzablock')
def update(self, engine : powerengine.Engine):
self.state['facing'] = {
'north': 'south',
'east': 'west',
'south': 'north',
'west': 'east'
}[self.state['facing']]
```
`__init__.py`
```py
from .main import PizzaBlock
```
`manifest.json`
```json
{
"name": "Pizza Mod",
"version": "1.0.0",
"blockTypes": {"PIZZA_BLOCK": ["pizzamod", "pizzablock"]}
}
```