Coordinator Configurator
The coordinator configurator tool can be brought up any time from the terminal by running configure on a coordinator. It will automatically come up if there is no valid configuration present, as shown in the first screenshot below.
General Tips:
- You can paste values into number/text fields
- You can navigate around with
tabandshift+tab(and arrow keys where applicable) - You can
ctrl+aor double click number/text fields to select all - When configuring the system, fields will be pre-filled with any valid existing configuration data
- You will be shown a summary of settings before any are saved
Below are two examples of the main menu. If the configurator is started by the coordinator app itself due to a lack of configuration, the red warning text in the first example will be present. If a configuration is present, the view option and color options button will be enabled (unlike in the first example).
If a legacy config.lua file is present, the import option will be shown as seen below.
You can jump directly to the color options using the Color Options button.
The coordinator app can also detect some monitor misconfigurations. If it does, it will launch the configurator and include a message within the red text, like below.
There is an embedded configuration file change log that will show what fields have been changed, added, or removed. This will help you figure out why a previously valid configuration may no longer be valid.
This option shows the currently active configuration of the device. Facility authentication keys will be censored via asterisks, but can be shown via the unhide button.
This option is only available if coordinator/config.lua is found. Those settings will be attempted to be imported and then a summary will be shown before the settings are saved.
Afterwards you will see this prompt. You may notice the coord.settings file is not previously mentioned here. It was previously used to remember burn rate targets, limits, modes, waste configurations, etc that the user makes while using the system. This information is automatically brought into the new settings file coordinator.settings.
Or this one if there was somehow a problem saving the settings.
This option will walk you through configuring the coordinator. Fields will be pre-filled with existing configuration data if present, otherwise the defaults will be shown.
You will need to provide channel information next. These are the channels you have chosen per this page, or they may be the defaults. Defaults are perfectly fine on single player, though not recommended on multiplayer if any other people may be using this project.
Next, continuing network configuration, there are some more options. There are the connection timeouts, which decides how many seconds to wait before assuming the connected devices are no longer available. If your server is very laggy, you may need to increase this, but be wary of the RTTs that the supervisor shows on its front panel screens.
After that, for a very basic level of security/utility there is the connection range, which prevents the coordinator from receiving any network packets that are beyond this distance away. A value of 0 disables this feature, allowing packets from any distance. Note, cross-dimensional packets (such as nether to overworld) have a nil distance, so with this feature enabled they will always be ignored.
Finally for network configuration is a more solid security feature (solid enough for a block game). You can provide a passkey as a facility key (same for every device on your network) that will be used to perform an HMAC-MD5 message authentication hash on each packet. This verifies packets received are authentic and from one of your devices. It does NOT encrypt your data (that takes far too long), but there should be no need for it to do so. This feature prevents others from connecting to or even controlling your system.
Please DO NOT USE ONE OF YOUR REAL PASSWORDS. This key is stored in plaintext (human readable), so anyone who has access to that computer or the server's filesystem (like admins) can see it.
You have the option of loading reactor unit count and cooling configuration (number of boilers and turbines in this case) information from the supervisor. This allows this configurator to accurately calculate monitor requirements. If you choose to skip (skip button enables after a short delay), you'll need to enter the unit count manually, and the computed monitor requirements will have to estimate dimensions rather than give specifics. Estimations will be denoted with an asterisk (*).
When you connect, you'll see this if it succeeds. If there was a problem, there will be a message shown. Note that just like with general connection issues, it could fail if you are using ender modems rather than wireless modems, your network channels are wrong, trusted ranges are too short (if enabled), or the facility keys do not match (if set).
After connecting and clicking 'Next', you will be shown the summary of the recorded data received from the supervisor.
If you skip the connection, you'll need to manually enter the number of reactor units in the system. If this does not match the supervisor, the coordinator won't connect when you start up. By manually entering this rather than connecting to the supervisor, the cooling configuration won't be shared with the coordinator, so monitor size requirements on the next screen will be estimations rather than exact requirements.
Based on prior selections and supervisor cooling information, the coordinator configurator tool will attempt to calculate monitor requirements. If you manually entered your reactor unit count, the main view monitor calculation could be inaccurate, at which point an asterisk (*) would appear next to it.
Note that sometimes it will say "at least" for main or flow view monitors as you can always make them taller (up to 6 high) than the requirement (though that will result in just empty space).
For now there is one option if you click "Legacy Options" on the requirements screen. This option is shown below, and disables the requirement for a flow monitor display. This is highly discouraged, as this functionality will be removed at some point before this code exits its beta release state and has a full release. This is meant for facilities that were built in the past with aesthetics in mind that do not have space for a flow monitor. At some point you'll need to upgrade, but for now you still have time.
On this page you will see a list of connected monitors, their current assignment (or 'Unused'), and their dimensions (width x height). This page will automatically update if you connect, disconnect, or resize monitors. Note that the "UNSET" buttons are only enabled once you have configured that particular monitor.
When you hit set, you'll see a screen for assigning that monitor. Be sure to read the text on that screen, as it is dynamic based on the size of the monitor you selected. The tool will identify what that monitor can fit and let you know. Below I selected an 8x6 monitor, which per the prior requirements screen can fit a main or flow display. Based on your assignments, the tool will pre-select the expected assignment. If you have assigned a main monitor and either your flow monitor or main monitor would fit a screen, it'll be smart enough to pre-select the flow monitor instead of pre-selecting a screen you already set. Note that that only applies if monitor sizes make sense. The default if none fit will just be main since there isn't an option for none :)
If you make an invalid selection, you'll get a warning, as shown below.
Setting it as Main, you'll end up back at the list again, but with that assignment updated. You can go back to the prior step if you want in order to check the requirements again if you wish.
Next I resized the flow monitor to fit (note that the previously shown height of 7 is not actually possible in-game, but it was with the CraftOS-PC app on my computer).
Now that it fits I can assign it as my flow monitor, and since I already assigned a main monitor, it'll pre-select that.
Lastly (order doesn't matter) I set all the unit displays except for Unit 4. If you miss any screens, you'll see a message at the bottom telling you which one (if multiple, it will just tell you one of them).
Assigning Unit 4 and hitting next will then allow me to continue on with configuration.
Here you can adjust the volume of the speaker used to play alarms. It is recommended to leave this at 1, which is the default.
On this page you can choose between various UI format preferences. First is the clock format used on the main and flow monitors, then next is the temperature scale to be used on the main and unit display monitors. All scales except for Kelvin will label units with a degree symbol, as per proper standards.
Before reaching the summary page, you will configure logging. This is likely to be unmodified, unless you want to store log files on a separate disk in-game for storage size reasons. That would allow for larger log files.
- Log file modes are either "replace the log file each time the main coordinator program starts" (not recommended) or "append to the log file each time the main coordinator program starts" (recommended)
- Log path should be a valid path to somewhere that a file can be created, otherwise the system will error on start
- Debug messages are only really valuable for finding bugs of course, so if you have a problem and can send more detailed logs by reproducing the problem with debug messages enabled, that's ideal. If you are out to break the program, you might as well enable debug messages before you attempt to do so so the logs are already there. Do be aware this results in significantly larger log files, which may cause them to be recycled (cleared and restarted) more often if there are space problems.
With color options, you can customize themes and color accessibility options. The coordinator has two different themes it uses. The main UI theme is used for the main, flow, and unit display monitors. The front panel theme is used for the coordinator's front panel. The top options, Smooth Stone and Sandstone, are the "light" themes (default). The bottom options, Deepslate and Basalt, are the "dark" themes.
Clicking "Accessibility" will bring up the color accessibility options. Here you will find a set of color modes intended to help with different types of colorblindness, plus options to change indicators to be black when off* or change greens to be blues. The three colorblindness modes always set indicators to be black when off* and green indicators to be blue, in addition to shifting the other colors used for indicators. For all modes, a preview of what the indicators will look like is shown. Note that exact colors vary by the theme you have selected since contrast needs to be maintained.
Non-standard color modes split up the NETWORK light on the front panel for clarity. Note that front panel LEDs have color tinted backgrounds while indicators on the coordinator displays use gray or black.
See this page for details on colorblindness modes.
-
Standard: Standard green/yellow/red shades with gray backgrounds (color tinted on front panel). -
Deuteranopia: Colorblindness mode targeted for Deuteranopia that uses modified blue/yellow/red shades with black backgrounds*. This has the same blue shade as Protanopia, but red and yellow are different. -
Protanopia: Colorblindness mode targeted for Protanopia that uses modified blue/yellow/red shades with black backgrounds*. This has the same blue shade as Deuteranopia, but red and yellow are different. -
Tritanopia: Colorblindness mode targeted for Tritanopia that uses modified blue/yellow/red shades with black backgrounds*. -
Blue for 'Good': Swaps blue in place of green in indicators. Uses standard shades for yellow and red, and maintains gray backgrounds (color tinted on front panel). -
Standard + Black: Same asStandard, except indicators have black backgrounds*. -
Blue + Black: Same asBlue for 'Good', except indicators have black backgrounds*.
* - Indicator background is black, except when the background the indicator is on is black.
If you jump to the color options from the main page, you will be able to apply the settings right away afterwards.
Once you apply, you will see this screen.
Or this one if there was somehow a problem saving the settings.
Lastly, you will see an overview of all the configurations that are going to be applied. Auth keys are hidden in this view until you use the unhide button (this does not affect how they are stored).
Once you apply, you will see this screen.
Or this one if there was somehow a problem saving the settings.