README.md

    Python Minecraft Server Status

    Описание

    Модуль для получения информации о сервере

    • Описание сервера (motd)
    • Количество игроков онлайн
    • Количество слотов

    Установка

    Клонировать репозиторий

    git clone https://gitflic.ru/project/artshefer/py-minesrv-status.git py_minesrv_status
    

    Примеры использования

    Принимающие параметры и значения по умолчанию:

    MineStatus(host: str = “127.0.0.1”, port: int = 25565)

    host - Доменное имя или IP сервера
    port - Порт сервера

    Как модуль

    from py_minesrv_status.minecraft import MineStatus
    server = MineStatus("127.0.0.1", 25565)
    server.getData()
    print(server.status)    # Статус сервера
    # True
    print(server.motd)      # Информация motd
    # A Minecraft Server
    print(server.online)    # Количество подключенных игроков
    # 1
    print(server.slots)     # Количество слотов
    # 10
    

    Как модуль, результат в виде справочника

    from py_minesrv_status.minecraft import MineStatus
    server = MineStatus("127.0.0.1", 25565)
    print(server.getDataDict())     # Информацию в виде справочника
    # {'status': True, 'motd': 'A Minecraft Server', 'online': 1, 'slots': 10}
    

    Командная строка

    python minecraft.py <host> <port> <mode>
    
    • host - Доменное имя или IP сервера
    • port - Порт сервера
    • mode - Способ возвращения информации
      • default - подробная информация
      • motd - только motd сервера (str)
      • online - только количество подключенных игроков (int)
      • slots - только количество слотов (int)
      • status - только статус сервера (bool)
      • json - возвращает в всю информацию (dict)

    Пример - default

    python minecraft.py 127.0.0.1 25565
    
    127.0.0.1:25565
    status = True
    motd = A Minecraft Server
    online = 1
    slots = 10
    

    Пример - motd

    python minecraft.py 127.0.0.1 25565 motd
    
    A Minecraft Server
    

    Пример - online

    python minecraft.py 127.0.0.1 25565 online
    
    1
    

    Пример - slots

    python minecraft.py 127.0.0.1 25565 slots
    
    10
    

    Пример - status

    python minecraft.py 127.0.0.1 25565 status
    
    True
    

    Пример - json

    python minecraft.py 127.0.0.1 25565 json
    
    {'status': True, 'motd': 'A Minecraft Server', 'online': 1, 'slots': 10}
    
    Описание

    Модуль для получения информации о сервере

    Конвейеры
    0 успешных
    0 с ошибкой