Metadata-Version: 2.1
Name: lcu_connector_python
Version: 1.0
Summary: Connects to the LCU
Home-page: https://github.com/Earleking/Python-LCU-Connector
Author: Earleking
Author-email: arek.fielding@gmail.com
License: MIT
Description: This project helps to easily connect to Riot Games' LCU API. 
        To use this, install with 
        ```
        pip install lcu_connector_python
        ```
        
        When you want to use it. 
        ```
        import lcu_connector_python as lcu
        api_connection_data = lcu.connect()
        ```
        If League of Legends is not install in the defualt location, "C:/Riot Games/League of Legends", then you will need to pass the location of your league folder. Example:
        ```
        import lcu_connector_python as lcu
        api_connection_data = lcu.connect("C:/Riot Games/League of Legends/RADS/projects/league_client/releases/0.0.0.178/deploy/LeagueClient.exe")
        ```
        
        The connect() function returns a dictionary which include data required to connect to the LCU
        ```
        {
            port: "localhost port number",
            url: "url used to communicated with the lcu",
            authorization: "auth token",
            connection_method: "http or https"
        }
        ```
Platform: UNKNOWN
Description-Content-Type: text/markdown
