https://github.com/anthonylangsworth/routeplotter

Plot the shortest route to visit a set of star systems in Elite: Dangerous.
https://github.com/anthonylangsworth/routeplotter

elite-dangerous mlrose python3

Last synced: 5 days ago
JSON representation

Plot the shortest route to visit a set of star systems in Elite: Dangerous.

• Host: GitHub
• URL: https://github.com/anthonylangsworth/routeplotter
• Owner: anthonylangsworth
• License: gpl-3.0
• Created: 2021-02-28T11:47:54.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T04:05:10.000Z (about 2 years ago)
• Last Synced: 2024-12-07T01:32:41.253Z (2 months ago)
• Topics: elite-dangerous, mlrose, python3
• Language: Python
• Homepage:
• Size: 219 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Route Plotter

## Introduction

**Route Plotter** is a small Python program that calculates the shortest route to visit all star systems where a minor faction in the **Elite Dangerous** galaxy is present. Visiting each star system in-game while running a tool like [Elite Dangerous Market Connector (EDMC)](https://edcodex.info/?m=tools&entry=150) ensures the data in third-party tools like [Inara](https://inara.cz/elite/news/), [EDSM](https://edsm.net) and [elitebgs.app](https://elitebgs.app/) is up-to-date. This helps players supporting a minor faction determine whether work is required to support, protect or expand their minor faction.

This problem is a traditional "travelling salesman" problem, solved using a genetic algorithm with the [MLROSE](https://mlrose.readthedocs.io/en/stable/) library.

## Use

In a Linux prompt (using [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) on Windows):

1. Download the files, such as by a `git clone` of this repository's URL.

2. Navigate to the folder containing the files from this repository.

3. Run `pip install -r requirements.txt` to download dependencies. This only needs to be run the first time. After that, the dependences are present.

4. Run `wget https://www.edsm.net/dump/systemsPopulated.json.gz` to download the latest data on populated star systems from [EDSM](https://edsm.net). Run this (1) the first time, (2) when the minor faction expands into a new system, (3) when the minor faction retreats from a star system or (4) it has been a while since you ran this program, just to be safe.

5. Run `gunzip systemsPopulated.json.gz` to decompress the downloaded file. Run this whenever you run the previous step to download new data on populated systems.

6. (Optional) Change the name of the minor faction in `MINOR_FACTION` around line 135. It defaults to my minor faction but yours is likely different. This only needs to be changed once.

7. Run `python bubble_runner.py`. It outputs the following to the console:

    1. The route. Start at any system then follow the jump sequence. Once you reach the end, jump to the first system and continue until you reach the star system you started at.

    2. The total distance in light years (LY). This is a rough measure of how spread out your minor faction is.

    3. The longest jump required. A ship that can jump at least this far can do the route in a single jump per step. 

## License

See [LICENSE](LICENSE).