Plan B

Copyright (c) 2018 Po Huit

Plan B is an EVE Online route planner. Plan B currently calculates a shortest route, but is eventually intended to show reasonable alternative routes also (hence the name).

This is very much a work-in-progress. See vision.md and reqs.md in docs/ for a roadmap and status.

See Build below for detailed build instructions.

Usage

The core of this project is a Rust library "crate", plan_b, containing most of the Plan B logic and internals. There are two user interfaces provided to this library: one command-line and one web.

Run The Command-Line Client

First follow the Build instructions below. Then

cargo run -p cmdline --release route <start> <dest>

to find and to display a shortest route from the system named start to the system named dest. The code will take a few seconds to load the map, a millisecond or so to find and display the route, and then will print all the hops, one per line, on stdout.

Say

cargo run -p cmdline --release diameter

to calculate the diameter of New Eden and show the endpoints of the three longest shortest routes. The code will take a few seconds to compute the answer.

Run The Webserver

Plan B can also run as a web service, powered by the Axum Rust web framework.

First follow the Build instructions below. Then, to start Plan B Web, cd into the web/ directory and

cargo run -p web --release

It will take a couple of seconds to load the EVE map before the server starts processing requests. The server currently listens on localhost:9146.

If you would prefer to use the Rocket Rust web framework, please see the branch rocket in this repository.

Build

This project is written mostly in Rust, with a little Python for convenience. It has only been used/tested on Linux. The build process is reasonably simple.

Get The Map Data (Optional)

I have included eve-map.json.gz in the repository top-level containing EVE System and Stargate data in compressed JSON. Copy this file to /usr/local/share on your box and ideally you should be set.

EVE Systems and Stargates have been changing recently. If you need to regather the map data, go to the fetch-map directory and run python3 fetch-map.py. This should run for less than 30 minutes with a decent Internet connection, and will create eve-map.json by fetching the necessary data from CCP's Tranquility server using ESI. Compress this file with gzip and you're ready to proceed as above.

Build The Rust Code

1. Get the relevant version of Rust installed on your system.

2. Run cargo build --release from the top-level directory.

The build will take a few minutes, and then the code should be ready to go.

License

This program is licensed under the "MIT License". Please see the file LICENSE in the source distribution of this software for license terms.

Acknowlegements

Thanks to Sparky Doosan for the name. Thanks to my EVE Online software development class for being part of the project. Thanks to the authors of the Axum framework, and to the various Rust developers whose crates are used by my project.