Metadata-Version: 2.1
Name: mcquery
Version: 0.1.0
Summary: Query tool for Minecraft: Bedrock Edition servers.
Home-page: https://github.com/w-gao/py-mcpe-query
Author: w-gao
Author-email: me@wlgao.com
License: MIT
Description: # mcquery
        
        [![PyPI](https://img.shields.io/pypi/v/mcquery.svg)](https://pypi.python.org/pypi/mcquery/)
        
        
        ## Introduction
        ------------
        mcquery (aka py-mcpe-query) is a Python software that uses the query protocol to ping a Minecraft: Bedrock edition 
        server for basic information.
        
        Note: If you get a timeout error, it might be that the target server do not support the query protocol. If that happens,
        you can use [mcstats](https://github.com/w-gao/py-mcpe-stats) instead, where you can ping a server without the query 
        protocol.
        
        ## Install
        -------
        
        #### Install via pip
        Run `pip install mcquery` in your terminal, and it will install the latest version of this project in your Python 
        environment.
        
        #### Install from source
        
        Clone this repository and run the following in the root folder of this project:
        ```
        python setup.py build install
        ```
        
        ## Usage
        -----
        
        #### Query with CLI
        
        After installation, the `mcquery` command will be available in your Python environment. You can perform a query with 
        the following command: `mcquery localhost`.
        
        Example:
        ```
        $ mcquery play.lbsg.net
        Motd: None
        Hostname: {-name-:-Lifeboat Proxy-,-node-:{-type-:-PROXY-,-ip-:-proxy14.lbsg.net-,-players-:91,-maxplayers-:400,-tps-:39.950001}}
        Game type: None
        Game id: None
        Version: None
        Server engine: None
        Plugins: ['']
        Map: None
        Num players: 91
        Max players: 400
        Whitelist: None
        Host ip: **.***.**.**
        Host port: 19132
        Players: []
        ```
        
        You can also specify the port with the `-p` option (e.g.: `mcquery localhost -p 19133`). For more options, please run 
        `mcquery --help`.
        
        
        #### Use as a module
        
        You can also use the API by writing the following code in your project:
        
        ```python
        from mcquery import mcquery
        
        host = "localhost"
        port = 19132
        
        with mcquery(host, port=port, timeout=10) as data:
            # data is a QueryServerData object
            print(data)
        ```
        
        ## License
        -------
        
        MIT &copy; 2017-2021 w-gao
        
Keywords: minecraft bedrock mcpe mcbe mcpeserver mcbeserver
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Networking
Requires-Python: >=3.6
Description-Content-Type: text/markdown
