swift-project / pilotclient

Cross-platform cross-simulator pilot client for virtual air traffic networks
https://swift-project.org
GNU General Public License v3.0
94 stars 27 forks source link

Documentation for lookup and matching script #176

Closed joeherwig closed 7 months ago

joeherwig commented 1 year ago

Due to the lack of documentation for the lookup and matching scripts it is really hard to get it running.

For instance I expected the outObject.logMessage to be displayed at the log tab within the client, but it ain't shown.

Based on documentation and examples I also fail to understand whether i need to put my script to replace the IVAO aircraft designator into lookup or matching stage.

Setting the checkbox seems necessary but there is no hint at all, what else needs to be done to get the script executed on (re)matching and how I can test and debug in the client.

Of course I tested the schript in js before loading it into the sim... 😄

If I 'm able to get it running I'm open to contribute the docs on my own... But currently I'm simply stuck...

ltoenning commented 7 months ago

@joeherwig I just pushed some changes to the documentation:

As I did not wrote the matching engine myself, it was somewhat complicated for me to get into all the details. But hopefully the documentation is at least a little bit clearer about this for now.

If anything is still unclear, feel free to reopen the issue and I will try to address this as well.

joeherwig commented 7 months ago

Great update! Thanks