Skip to content

README_ru.md

Latest commit

 

History

History
107 lines (66 loc) · 4.52 KB

README_ru.md

File metadata and controls

107 lines (66 loc) · 4.52 KB

English

Модуль языка Python для Plugify

Модуль языка Python для Plugify — это мощное расширение проекта Plugify, позволяющее разработчикам писать плагины на Python и без труда интегрировать их в экосистему Plugify. Если вы энтузиаст Python или хотите использовать богатую экосистему библиотек Python, этот модуль обеспечит необходимую гибкость и удобство.

Возможности

  • Плагины на Python: Пишите плагины полностью на Python, используя мощные библиотеки и инструменты языка.
  • Простая интеграция: Лёгкое подключение Python-плагинов в систему Plugify, с поддержкой взаимодействия с плагинами на других языках.
  • Кросс-языковое взаимодействие: Бесшовное взаимодействие между Python-плагинами и плагинами на других поддерживаемых языках.
  • Удобная конфигурация: Простые конфигурационные файлы для настройки параметров Python-плагинов.

Начало работы

Требования

  • Python 3.12 (обязателен)
  • Установленный фреймворк Plugify

Установка

Вариант 1: Установка через менеджер плагинов Plugify

Вы можете установить модуль Python с помощью менеджера пакетов Mamba, выполнив команду:

mamba install -n your_env_name -c https://untrustedmodders.github.io/plugify-module-python3/ plugify-module-python3

Вариант 2: Ручная установка

  1. Установите зависимости:

    a. Windows

    Настройка CMake-инструментов через Visual Studio Installer

    b. Linux:

    sudo apt-get install -y build-essential cmake ninja-build

    c. Mac:

    brew install cmake ninja

  2. Клонируйте репозиторий:

    git clone https://github.com/untrustedmodders/plugify-module-python3.git --recursive

  3. Соберите модуль языка Python:

    mkdir build && cd build
cmake ..
cmake --build .

Использование

  1. Интеграция с Plugify

    Убедитесь, что модуль Python находится в той же директории, что и ваша установка Plugify.

  2. Создание плагинов на Python

    Разрабатывайте плагины на Python с использованием API Plugify для Python. Подробности в руководстве по Python-плагинам.

  3. Сборка и установка плагинов

    Поместите ваши Python-скрипты в директорию, доступную для ядра Plugify.

  4. Запуск Plugify

    Запустите фреймворк Plugify — он автоматически загрузит ваши Python-плагины.

Пример

from plugify.plugin import Plugin


class ExamplePlugin(Plugin):
	def plugin_start(self):
		print('Python: OnPluginStart')
		
	def plugin_update(self, dt):
		print("Python: OnPluginUpdate - Delta time:", dt)

	def plugin_end(self):
		print('Python: OnPluginEnd')

Документация

Полную документацию по созданию Python-плагинов для Plugify вы найдёте в официальной документации Plugify.

Участие

Вы можете внести вклад, открыв issue или отправив pull request. Мы будем рады вашим идеям и отзывам!

Лицензия

Этот модуль языка Python для Plugify распространяется по лицензии MIT.