pinger-bot#

Простий Discord бот для відстеження ваших Minecraft серверів.

Особливості#

Безкоштовно! Ми не хочемо нічого від вас!
Can be self Hosted - the bot is fully under your control!
You can use it without any hosting!
Can grab MOTD from any server in one command!
Supports both Java and Bedrock servers!
Can be easily localized to your language!

Try it out!#

Check the invite link to invite the bot to your server.

Screenshots#

Встановлення#

git clone https://github.com/PerchunPak/pinger-bot.git
cd pinger-bot

Встановлення `poetry`#

Next we need install poetry with recommended way.

Якщо ви використовуєте Linux, використайте команду:

curl -sSL https://install.python-poetry.org | python -

Якщо ви використовуєте Windows, відкрийте PowerShell від імені адміністратора та використайте:

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -

Встановлення залежностей#

poetry install --only main

Також, для роботи бота, вам потрібно вказати яку базу даних ви будете використовувати. Зараз ми підтримуємо тільки SQLite, MySQL and PostgreSQL. Для встановлення необхідних залежностей, треба просто використати аргумент -E з ім’ям бази даних в нижньому регістрі.

Наприклад:

poetry install --only main -E mysql

Компіляція перекладів#

Це потрібно навіть якщо ви хочете використовувати просто англійську.

pybabel compile -d locales

Міграції бази даних#

Вони зроблять базу даних для вас. Вам не потрібно робити жодної таблиці руками, просто запустіть цю команду:

alembic -c pinger_bot/migrations/alembic.ini upgrade head

Конфігурація#

All bot configuration happens in config.yml, or with enviroment variables. All configuration settings described in config.py.

База даних#

Коли встановлюєте базу даних, є також декілька нюансів:

Якщо ви хочете використовувати SQLite, вам потрібно вказати шлях до файлу. Рекомендовано встановлювати абсолютний шлях.
Щоб дізнатися, що треба встановлювати в поле db_uri дивіться цю статтю.

Запуск бота#

python pinger_bot

Якщо щось не зрозуміло#

Ви завжди можете написати мені!

Використання в Docker#

Дивіться документацію.

Оновлення#

Для оновлення, вам просто потрібно пере-скачати репозиторій (не забудьте зберегти конфіг та базу даних), якщо ви використовували git для скачування, тоді просто використайте git pull.

Після цього, треба оновити переклади і базу даних, команди аналогічні як при встановленні:

pybabel compile -d locales
alembic -c pinger_bot/migrations/alembic.ini upgrade head

Дякую#

Цей проект був згенерований за допомогою python-template.

Сторінки#

Гайди

Використання в Docker

Сторінки

API Документація

API Документація