jaghaimo/hypernet

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Hyperspace Network

Hyperspace Network, or HyperNET in short, is a sector-wide hyperspace network to query content of known markets.
Using the network one can search for administrators or officers with a given personality, query markets for weapons, fighter wings, modspecs, or blueprints, or locate specific ships for sale.

![Demo](https://i.imgur.com/iP8qXrt.png)

## Mod Configuration

There are two configurable values that control market searching algorithm:

* `marketHasToBeNotHidden` (default: `true`) - will only include results from non-hidden markets (markets shown as "inhabited" on Sector Map), and
* `marketHasToBeDiscovered` (default: `false`) - will only include results from discovered markets (all non-hidden markets are considered discovered).

## Mod Integration

This mod is marked as "utility" mod, meaning it will work with any and all mods, total conversions included.

HyperNET queries ignore markets that are hidden and/or not discovered.
Additionally, there are four CSV files to custom tailor market exclusion list:

* `factions.csv` file containing faction IDs to skip,
* `markets.csv` file containing market IDs to skip,
* `systems.csv` file containing star system IDs to skip, and
* `tags.csv` file containing market or star system tags to skip.

To skip any matching markets, add one or more files in your mods `data/config/hypernet/` folder with appropriate IDs or tags.