Auto_Neutron

Auto_Neutron is a utility tool to help you plot routes created using Spansh's route plotters or for CSV files that use Spansh's syntax.

What it does

Auto_Neutron helps you traverse routes generated from outside the game by either copying the next route system into your clipboard, or by executing a custom AHK script that can use the system name.

Example of AHK script in action, with no user keyboard input apart from the hotkey.

Features

• Built in plotters using Spansh's api
• Plotting from CSV files
• Saving of routes
• Low fuel alert when customisable threshold is reached

Installation

To install, download either of the latest releases of Auto_Neutron, or run it directly with python. You can choose either the self-contained executable file, or the zip archive which contains the application in a directory which is a bit faster to launch.

On the initial launch, Windows may warn you about this being an untrusted application because the executable is not signed, to ignore this warning, press on More info and then click Run anyway.

Usage

On launch, the app will display a popup that allows you to create a new route, either from a CSV file, Spansh, or a previously saved route.

The dropdown list at the bottom left lets you select the journal to follow for the route. If you started a new game while the window is open, you can press the refresh button next to it to refresh the available journals.

After creating a route, the popup will close and the main window will be filled with route entries, and the plotter will start.
When you reach a system in the route, Auto_Neutron will either copy the next system into the clipboard, or it'll feed it to AHK.

In case you want to skip to a system, you can double-click its entry.

Further interactions like editing the system entries, starting a new route, changing settings, or saving the current route and its position are available in the right-click context menu of the main window.

In case you want to plot with Spansh, but the source or target systems are not found, you can use the nearest window to find the nearest known system around given coordinates.

To use the AHK feature, the copy mode has to be disabled in the settings. The AHK path may need to be configured before this is possible.

Plotting from CSV files

Auto_Neutron will try to match the CSV file's format to one of the supported formats from Spansh, if no format is matched the file will be parsed as a csv file with one column, with an optional "System Name" header.

Settings

Appearance

• The font dropdown, size chooser and bold checkmark let you control the font used in the main window.
• The dark mode checkmark modifies the app's theme, in the "partially checked" (box) state, the current Windows theme will be used.
• A different language can be chosen from the available translations.

Behaviour

• The "Save route on window close" checkmark changes where the current route and its position are saved to be reused later when the window is closed
• The copy mode checkmark changes the mode the application runs in - copying to clipboard, or running an AHK script. Before it can be unchecked to use AHK, the path to AHK has to be configured through the AHK Path button to the right
• When the auto scroll checkmark is checked, the app will automatically auto scroll the main window to the next system on route when the current system is reached.
• When the loop routes checkbox is checked, routes that reach their end will loop back to the start.

Alerts

• If the taskbar fuel alert checkbox is checked, the app will flash on the taskbar for 5 seconds when low fuel is reached.
• If the sound fuel alert checkbox is checked, the app will play a beep, or the alert file when low fuel is reached.
• The percentage value to be chosen represents the % of the current ship's FSD's maximum usage to be left in the tank before triggering an alert, for example if your FSD can use 4t of fuel at once and the percentage is set to 150%, the alert will trigger with 6t of fuel left in the tank.

AHK script

Simple mode

In simple mode, a template script which opens the galaxy map, navigates to the search field, and pastes the next system is used. The binds used to do this can be configured with the provided input fields.
The top field configures the hotkey used to trigger the script.

Custom mode

With this mode, you have complete control of the AHK script to use, the script from the simple mode is used as a default.
The custom script is added to a template which exposes the system name to use in the system variable.

Nearest window

This window provides an interface to Spansh's nearest API.

The from location button will copy your current location's coordinates into the input boxes.
The from target button will copy your current target's coordinates into the input boxes. Because the game doesn't expose the target's location, this is an approximation and may not be entirely accurate.

After searching for a system you can copy the result system's name into the source or destination text inputs with their respective buttons.

Running directly

To run the application directly with Python, clone the repository and install from requirements.txt.

$ git clone [email protected]:Numerlor/Auto_Neutron.git  # Clone the project
$ cd Auto_Neutron  # Switch to the cloned folder
$ pip install -r requirements.txt
$ python main.py

Or install and run through poetry.

$ poetry install --no-dev
$ poetry run start