EDPyPal

Companion tool to visual game data in Elite Dangerous
View Demo · Report Bug · Request Feature

Table of Contents

1. About
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About

EDPyPal is an app that reads Elite Dangerous game data, in real time, and then shows relevant information.

• Find the closest repair,refuel,restock,etc. station in the system
• What stars are scoopable in your route
• How many jumps left in your route
• Quickly see what modules you have attached as well as if they are engineered
• View station and system information quickly
• And more...

EDPyPal is written in Python and uses matplotlib to draw 3D plots to visualize Elite Dangerous game data. It reads JSON data from C:\Users\userID\Saved Games\Frontier Developments\Elite Dangerous\ folder and parses it in real time. Any changes are instantly updated and it can auto switch between different views/modes based on if your ship is docked or not. Launch it and let it do it's thing!

EDPyPal is made to run on another monitor in fullscreen.

Built With

• Python
• Matplotlib

Youtube Demo

• Video of EDPyPal in action

Nav Mode

Nav Mode shows the following information:

• Top left is closest stations for Refuel, Repair, Rearm, Outfitting, Shipyard, Material Trader (ignores Fleetcarriers and planet landings)
• Top middle is fuel level as well as next fuel star. Also color coded to indicate level.
• Top right is current mode (Nav or Docked/Stats)
• Center middle is is a rotating 3D plot of what you currently have routed in your navigation computer. Current system, next system, and destination system are labeled as well as a number of systems not shown if you have a long route planned (indicated by ----). The 3D plot also shows star types (orange is scoopble, red is non-scoopable) and distance in LY between stars. Plots with dashed lines at the end indicate there are more jumps not shown.
• Bottom left is current system as well as body, non-body, and fleet carrier count
• Bottom middle is next system and jumps remaining to destination
• Bottom right is destination system

Docked/Stats Mode

Docked/Stats Mode that shows the following information:

• Top left is current system information
• Top middle is station information
• Top right is various ranks
• Center is a system view showing planetary and station landings
• Middle left is ship info/stats, fuel (tons), cargo (tons), jump range
• Middle right is commander and credits
• Bottom is module information, orange colored items indicate engineered items and their level

(back to top)

Getting Started

Prerequisites

• Elite Dangerous: Odyssey
• Python 3 (latest)
• matplotlib (latest)

  pip3 install matplotlib

• [Optional (Highly Recommended)]
  • Copy JSON data from https://eddb.io/api to
    Elite Dangerous folder: C:\Users\userID\Saved Games\Frontier Developments\Elite Dangerous
    This is not required but if you don't have these JSON files specific stats data will not be shown. Also, you will need to update these files every so often as the data changes in Elite Dangerous. EDDB updates them nightly on their website.
  • systems_populated.json
  • stations.json
  • modules.json

Installation

1. Clone the repo

   git clone https://github.com/tuxthepenguin84/edpypal.git

(back to top)

Usage

Once you have all the pre-reqs installed and the repository cloned you can run EDPyPal.

• You must be in game in Elite Dangerous before you launch EDPyPal, otherwise it shoes your previous game session which will not update.
• Elite Dangerous needs to be run in Borderless mode in your Elite Dangerous display settings, otherwise you will get bad flickering from the EDPyPal app.
• Review open issues, you will almost certainly run into a bug or two

Launch EDPyPal

python path\to\EDPyPal.py

Key Bindings

(1) - Switch to Docked/Stats Mode
(2) - Switch to Nav Mode
(0) - Switch to Auto Mode [default] (Automatically switches mode based on in game events)
(p) - Pause/unpause rotating map in NavMode, then you can use your mouse to manually rotate the map.
(r) - Refresh rotating map in NavMode
(f) - Full screen toggle
(Esc) - Exit (gracefully) EDPyPal

To quite EDPyPal, make sure EDPyPal has focus and press the Escape key

Help

There are a couple optional flags you can run to force specific modes, window, locale, shutdown, and version settings. You can view those with the -h flag.

python path\to\EDPyPal.py -h

(back to top)

Roadmap

• [-] More modes (Combat and Mining maybe?)
• [-] More stats on closest system services

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
2. Commit your Changes (git commit -m 'Add some AmazingFeature')
3. Push to the Branch (git push origin feature/AmazingFeature)
4. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Sam Dockery - @SFTuxTweet - [email protected]

Project Link: https://github.com/tuxthepenguin84/edpypal

(back to top)

Acknowledgments

• Best-README-Template

(back to top)