Add Russian

This commit is contained in:
2023-07-10 23:48:04 +03:00
parent 7472aaf206
commit 3be544eab2
14 changed files with 272 additions and 11 deletions

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")

35
docs/ru/plugins/readme.md Normal file
View File

@@ -0,0 +1,35 @@
# Система плагинов
## Установка библиотеки с "Заглушками"
###### (Это значит, что не будет работать без сервера, но IDE подскажет API)
###### (Библиотека ещё в разработке)
* Используя pip:\
`$ pip install ...`
* Из исходников:\
`git clone https://github.com/kuitoi/...`
## Пример
```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)
```
Так же более обширный пример можно найти в [example.py](./example.py)
* Базовые ивенты: ['on_started', 'on_auth, 'on_stop']
* Создание своего ивента : `beam.register_event("my_event", my_event_function)`
* Вызов ивента: `beam.call_event("my_event")`
* Вызов ивента с данными: `beam.call_event("my_event", data, data2)`
* Вызовы с указанием переменой _**не поддерживаются**_: `beam.call_event("my_event", data=data)`