Update docs

This commit is contained in:
2023-07-07 20:31:38 +03:00
parent f22c3fc69e
commit 919296ab15
5 changed files with 75 additions and 2 deletions

36
docs/plugins/example.py Normal file
View File

@@ -0,0 +1,36 @@
import BEAMP # Import server object
beam = BEAMP("TestPlugin") # Init plugin with name "TestPlugin"
log = beam.log # Use logger from server
def on_load():
# When plugin initialization Server uses plugin.load() to load plugin.
# def load(): is really needed
log.info(beam.name)
# Events handlers
def on_started():
# Simple event handler
log.info("Server starting...")
# Simple event register
beam.register_event("on_started", on_started)
def any_func(data=None):
# Custom event handler
log.info(f"Data from any_func: {data}")
# Create custom event
beam.register_event("my_event", any_func)
# Call custom event
beam.call_event("my_event")
beam.call_event("my_event", "Some data")
# This will be an error since any_func accepts only one argument at the input
beam.call_event("my_event", "Some data", "Some data1")

33
docs/plugins/readme.md Normal file
View File

@@ -0,0 +1,33 @@
# Plugins System
## Install
[//]: # (TODO: BEAM LIB)
Lib can't ready to use
* From pip:\
`$ pip install ...`
* From source:\
`git clone https://github.com/kuitoi/...`
## Example
```python
import BEAMP
beam = BEAMP("TestPlugin")
logger = beam.log
def load(): # Plugins load from here
print(beam.name)
def on_started():
logger.info("Server starting...")
beam.register_event("on_started", on_started)
```
* Basic Events: ['on_started', 'on_auth, 'on_stop']
* Create new event : `beam.register_event("my_event", my_event_function)`
* Call event: `beam.call_event("my_event")`
* Call event with some data: `beam.call_event("my_event", data, data2)`
* Calls _**can't support**_ like this: `beam.call_event("my_event", data=data)`