README.md

FlightGear Companion

Little things that ARE making a diffrence!

Set of small features that are enhancing the FG experience. (List of planned/added features below)

Important notice

After the next major update (stefan-0.5) this branch will be marked as legacy!

Legacy branch will receive Version level updates (when applicable) and should be kept in the same general concept as it is now.

Next update (fgcp-latest-0.6) will be completely different because it will be trying to replace the default launcher with many fresh features, cleaner interface, more accessible settings and loads more. However, it will be compatible with both stefan-0.5 and fgcp-legacy-0.6 when it comes to social server infrastructure.

The fgcp-legacy will introduce all tweaks contained in fgcp-latest versions but won't replace your launcher.

This versioning system will be discarded after 1.0, after that legacy branch will only receive compatibility updates (marked as fgcp-legacy-1.0-sf1 for example)

As they said, Set your goals high to achieve great things!

Warning!

This project is work in progress and is not polished. Code is messy and really bad at error handling. These things should be fixed in the future. Proceed with caution!

Features

• Discord Rich Presence
  • Basic Rich Presence
  • Customization Options
  • Custom Placeholders
  • Join in Multiplayer (For Server refer to https://github.com/justkowal/FGCPServer)
• Auto Updates (Coming REALLY Soon)
• Addon App Store (Coming Soon)
• LiveATC Dynamic Radio
• Better Flight Stats

If you have any suggestions - use GitHub Issues with proper tag!

Check out other FGCompanion projects:

• FGCompanion - Poland Enhanced (custom scenery adding better Polish airports, compatible with OSM Buildings)

Running from source

Firstly install git (recommended) and Node + NPM (mandatory, Latest > LTS)

1. Clone the repository either by downloading as zip and unpacking or running git clone https://github.com/justkowal/FGCompanion
2. In the directory containing repo run npm install (On Linux RClick > Open in terminal. On Windows Shift + RClick > Open PowerShell Window Here)
3. Run npm start to start the app

Compiling from source

Once again Node + NPM (Latest > LTS) is needed

1. Do the steps 1 & 2 from "Running from source"
2. Use npx electron-packager . FGCompanion --platform=[ex. win32] For more detailed options refer to electron-packager manual

Credits:

• JustKowal (Coding and stuff)
• Klaudiae (Beating JustKowal with a carrot Carrot shaped pencil case)