Giter Club home page Giter Club logo

edce-client's Introduction

edce-client

Elite Dangerous Companion Emulator

Purpose

This is an interface that emulates an iPhone accessing the Elite Dangerous Companion web API, which is normally used by a mobile application developed by Frontier Developments. This experimental code has not been created in association with Frontier Developments and is unsupported by them.

The EDCE client queries your Commander data on the Elite Dangerous Companion site as you would on your iPhone, and retrieves the data to file in JSON format. It also publishes market data to EDDN. No private information is published.

Installation

  • Requirements:
    • Python 3.3 or higher
    • Python requests library: pip3 install requests
  • Run the client-setup.py program: python3 client-setup.py
  • Enter your Frontier store credentials (NOTE: The password is stored unencrypted in the edce.ini file. You can leave the password blank, however this means you will need to run the client in interactive mode and you will be prompted to enter the password every time)

Usage

  • Launch the client: python3 edce_client.py
  • The first time you run the program, the Elite Dangerous Companion website will request a verification code, which shall be sent to your account email. Enter the code at the prompt. You should only have to do this once
  • The program will query your Commander's data, and dump the JSON result in the log directory (LZMA compressed, can be examined by 7-zip)
  • The program will also post the market data from the current station where your Commander is docked to EDDN. If he/she is not docked, the data is not sent. (NOTE: Currently using the TEST schema until more stable)

General Notes

  • Protect your edce.ini file as it contains your Frontier store credentials in unencrypted form
  • Avoid querying the Elite Dangerous Companion site too often in order to avoid overloading it. As a rule, try not to query more than once every 2-3 minutes.
  • The web API sometimes lags actual game state by several seconds. For example, you might dock, but only be able to post market data to EDDN after a few seconds until the web API catches up.
  • You can modify the code as you wish, the edce subdirectory contains the core module to access the Elite Dangerous Companion web API

edce-client's People

Contributors

andargor avatar anthornet avatar betek avatar jamesremuscat avatar marginal avatar sammcj avatar

Watchers

Kevin Hatfield avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.