https://github.com/klightspeed/elitedangerousregionmap
Elite Dangerous codex region map data, and various sample scripts / modules using it to place systems in codex regions
https://github.com/klightspeed/elitedangerousregionmap
codex-region elite-dangerous galaxy-map
Last synced: 5 months ago
JSON representation
Elite Dangerous codex region map data, and various sample scripts / modules using it to place systems in codex regions
- Host: GitHub
- URL: https://github.com/klightspeed/elitedangerousregionmap
- Owner: klightspeed
- License: mit
- Created: 2020-09-11T10:59:35.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-26T20:56:24.000Z (almost 2 years ago)
- Last Synced: 2024-06-27T01:05:41.881Z (almost 2 years ago)
- Topics: codex-region, elite-dangerous, galaxy-map
- Language: C#
- Homepage:
- Size: 665 KB
- Stars: 16
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
The primary function of these scripts and classes is to take a set of coordinates and determine which Elite Dangerous codex region they are in.
Each implementation has a `main()` entrypoint which takes one or more system names as command-line arguments, which are looked up using EDSM, and their region and the region of their boxel (if different) are output.
Each implements a `findRegion(x, y, z)` function / method, a `findRegionForBoxel(id64)` function / method, and a `findRegionsForSystems(sysname)` function / method.
Please feel free to use and modify any of these implementations as needed for your use case.
## Functions
`findRegion(x, y, z)`
This takes a set of coordinates and determines which Elite Dangerous codex region they are in.
`findRegionForBoxel(id64)`
This takes an id64 (system address) and determines which Elite Dangerous codex region its boxel is in.
`findRegionsForSystems(sysname)`
This takes a system name, looks it up on EDSM, and returns details on which region each of the returned systems is in.
## Implementations
### Python
The functions are implemented in `RegionMap.py`
### C#
The methods are implemented in the `EliteDangerousRegionMap.RegionMap` static class in `RegionMap.cs`
### Javascript
The functions are exported by the `RegionMap.js` CommonJS module
### Rust
The functions are implemented in the `region_map.rs`
It needs 2 crates:
- `reqwest` (with the feature `blocking`)
- `serde_json`
:warning: These crates are only needed for the CLI program. If you only need base functions given coordinates or id64, you can ignore this.
# Background
There are 42 regions in a 93 segment by 30 ring polar grid.
By probing the edges of the regions (using the region name displayed when jumping between systems), it has been determined that the actual region map is on a 49.3494ly grid (essentially 4096 / 83 ly).
The region name displayed when jumping between systems is the region at the coordinates the system being jumped to are at.
The region name in the galaxy map is the name of the region at the 0/0/0 corner of the 10 ly (A) boxel the cursor is in.
The region name written to the journal and shown on the main page of the codex is the region at the 0/0/0 corner of the system's boxel.
Any codex discoveries are recorded by the game in the region the system's coordinates are in, but won't be shown unless or until the boxel coordinates are in the same region. This discrepancy has been reported to Frontier - see https://issues.frontierstore.net/issue-detail/13286
The regions were mapped by following the edges of the regions on the galaxy map (taking into account that the galaxy map is accurate to 10ly).
# Files
`RegionMap.svg` has the region bounds as determined by mapping their edges.
`RegionMap.png` is a grayscale map of the regions, with #000000 being outside the map, #A8A8A8 being region 1 (Galactic Centre), going down in steps of #040404, down to region 42 (The Void) which is #040404.
`RegionMapData.py`, `RegionMapData.json`, `RegionMapData.cs`, and `region_map_data.rs` were generated from `RegionMap.png` using `RegionMap-datagen.py` - they contains (length,region) tuples of the run-length encoded data, with the rows going from bottom (minimum Z) to top.