Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frankkopp/msfs_model_matching
Simplified managing of model matching rules for VATSIM vPilot and MSFS
https://github.com/frankkopp/msfs_model_matching
Last synced: about 1 month ago
JSON representation
Simplified managing of model matching rules for VATSIM vPilot and MSFS
- Host: GitHub
- URL: https://github.com/frankkopp/msfs_model_matching
- Owner: frankkopp
- License: other
- Created: 2021-05-26T10:48:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-08-06T16:17:41.000Z (over 3 years ago)
- Last Synced: 2024-10-12T05:51:53.701Z (2 months ago)
- Language: Go
- Homepage:
- Size: 730 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# MSFS VATSIM vPilot MatchMaker v1.1
[](https://github.com/frankkopp/msfs_model_matching/actions/workflows/go.yml)
[](https://github.com/frankkopp/msfs_model_matching/actions/workflows/codeql-analysis.yml)
[](https://goreportcard.com/report/github.com/frankkopp/msfs_model_matching)
[](https://github.com/frankkopp/WorkerPool/blob/master/LICENSE)
Intended for Microsoft Flight Simulator 2020 and VATSIM vPilot Client.
Automatically generates a vPilot match making file (VMR) for all liveries in the given folder.
It allows to configure the base-sim-plane-models to be used, the default-liveries to be used
and also a list of alternative ICAO codes for airlines which should use the same livery.
Version 1.0 and later have a Windows UI and use one ini-file for configuration which
can be edited within the UI.
## Download
- Current Release: https://github.com/frankkopp/msfs_model_matching/releases/tag/v1.0beta1
- Latest build from commits to master: https://github.com/frankkopp/msfs_model_matching/releases/tag/latest
## Installation
- Download the latest release, or the most current master build as zip files
- Extract this to a folder (I use the vPilot files folder in my Documents folder)
- When started, the app creates a default ini which can be saved to disk from the UI
- You can also download example ini- and rules-files from the /examples folder
If you do not like to download and run an exe file then you can always compile by yourself:
- Download and install go (v1.16 or newer) here: https://golang.org/dl/
- Build: go.exe build -o .\matchmaker.exe ./cmd/matchmaker/...
- Start: .\matchmaker.exe
## Configuration
### matchmaker.ini
This contains all configuration for the application. It covers several sections:
- [paths]
- liveryDir: the directory to search for liveries.
- outputFile: the path and filename where the rules should be stored
- [defaultTypes]
- = :
this maps a base_container (aka base plane / part of the livery aircraft.cfg data) to one or more default liveries.
vPilot chooses them if a player's icao callsign is unknown.
- [typeVariations]
- = :
this maps a base_container (aka base plane / part of the livery aircraft.cfg data) to one or more plane type codes.
E.g. "A320" or "B748". vPilot uses the type code the pilot entered when connecting to determine the plane's
type and this mapping make sure an appropriate livery is mapped.
- [icaoVariations]
- = :
this list tells the application that several icao callsigns are to be mapped to the same livery. Many airlines
have several callsigns or pilot's use wrong ones. E.g. BAW (British Airways) also has SHT for Shuttle and some
users just use BA.
vPilot extracts the icao from the pilot's callsign. E.g. DLH291 ==> DLH ==> Lufthansa
- [customData]
- this section is handled by the UI only. It stores any changes to metadata of liveries. Mainly if the livery should
be skipped or processed and to correct the ICAO code which is sometimes missing or wrong in the livery metadata.
- No need to configure anything here.
- [application]
- this section is handled by the UI only. It stores any data the application needs otherwise.
E.g. last window position.
- No need to configure anything here.
``
## Usage (general)
matchmaker.exe can be used via the UI or the command line.
When started without any options matchmaker uses the UI.
If there is no ini file matchmaker uses a default ini which can be saved as a file for the next start.
Run:
````
matchmaker.exe
````
### UI HowTo
The UI is simple and has three tabs and a statusbar.
The tabs are:
- Parse Liveries:
- This has a list of all found liveries and their status. Livery metadata can be edited here and
liveries can be activated and deactivated.
Click on the large Scan button so start the search for liveries in the configured folder.
- How to read the list:
- Process column:
- green: livery can be used in rules
- red: livery can't be used (ICAO missing)
- check-mark
- when set livery will be used (NOT skipped)
- when not set livery will be skipped
- Livery Configuration File column: is green and Custom column has check-mark:
there is a custom rule for this Livery
- Base Container column:
- if this is red the Base Container is not configured to be used. Add a default livery and
a mapping to at least one ICAO if you want to use this livery.
Of course the plane has to be installed in MSFS - e.g. "Aerosoft_CRJ_700", or others
````
[defaultTypes]
NEW_PLANE_MODEL = DEFAULT-LIVERY1, DEFAULT-LIVERY2
[typeVariations]
NEW_PLANE_MODEL = ICAO1, ICAO2
````
- Title column:
- if this is blue this livery is one of the default liveries for this base type
- Context menu:
- Edit: to edit the metadata of the livery - basically only ICAO codes are editable
- Remove: removes any custom rules for the Livery
- Activate/Deactivate: use to activate/deactive multiple selected liveries
- AddToDefault: Add this livery as a default livery for this base type
- RemoveFromDefault: Remove this livery as a default livery for this base type
- Generated Rules:
- This tab show the generated rules for vPilot. Every time a change is made to the list all rules
a (re-)generated with the most current configuration.
- Rules can then be copied to clipboard or saved to file for direct use by vPilot.
- Configuration:
- This tab shows a simple text editor to edit the ini directly in the UI.
- Make sure to "Apply changes" when you edit the configuration and also use "Save to File" if you want to make your
changes permanent.
Statusbar:
6 boxes:
- number of liveries found
- number of liveries to process
- number of generated mappings**
- number of actual XML rules generated**
- reminder if rules are copied or saved
- reminder if configuration is saved.
** several mappings can become on rule
### Command line options
````
Usage of matchmaker.exe:
-dir string
path where liveries are searched recursively
-ini string
path to ini file (default "matchmaker.ini")
-noUI
does not use ui and starts directly with given configuration
-outputFile string
path and filename to output file
-verbose
prints additional information to console
-version
prints version and exits
````
## How it works:
When started MatchMaker.exe searches recursively for aircraft.cfg files in the given folder
- A livery's aircraft.cfg must contain these three data points otherwise it can't be processed:
- base_container
- icao_airline
- title
For each found aircraft.cfg (aka Livery) rules will be created based on the ICAO code of the livery if the
base_container is a model which is configured and has at least one mapping to a plane type code.
If there are several liveries for an ICAO code, and a type code the liveries will be concatenated, so vPilot can
choose randomly which to use.
If metadata is missing it can be added in the gui and saved to the ini.
Example:
- Livery for A320Neo for Lufthansa (DLH)
- Base container for A320Neo is: Asobo_A320_NEO
- TypeCodes for this base container are: A19N:A20N:A21N:A318:A319:A320:A321:B732:B733:B734:B735:B736:B737:B738:B739:B73X
- Alternative ICAO airline codes for DLH are: DLH:LHA:CLH
Generated rules:
````
````