Skip to content

SoBo7a/MSFS-Events-Calendar-Viewer

Repository files navigation

MSFS Events Calendar Viewer

MSFS Events Calendar Viewer is an independent desktop application - written in Vue 3 and compiled, using "vue-electron-builder" - to provide a convenient way to explore and stay updated on flight simulation events.

It utilizes the Microsoft Flight Simulator Forums Calendar as its data source, offering users a comprehensive view of community-driven events.

Please note that MSFS Events Calendar Viewer is not affiliated with or endorsed by Microsoft Flight Simulator or its developers.

The program is written in Vue 3, using "vue-electron-builder".

This program comes with ABSOLUTELY NO WARRANTY.


Features

  • Shows Events up to 30 Days in the past
  • Shows all future Events
  • Provides a faster usage of the MSFS Events Calendar. This is archieved by caching and more optimiziations
  • Automatic Application updates
  • Dark mode
  • And more...

Alt Text Alt Text

Alt Text Alt Text


Installation

To use the app, please follow the steps below:

  • Go to the releases section of this GitHub repository.
  • Download the latest version of the app for your operating system.
  • When downloading the app, your web browser and operating system may display warnings about the installer. You can safely disregard these warnings.
  • Once the download is complete, locate the downloaded file and run the installer.
  • Follow the installation prompts to complete the installation process.
  • After the installation is finished, you can launch the app from your desktop or applications menu.

Please note that if you encounter any warnings during the installation process, they can be safely ignored as the app is open-source and doesn't contain any malicious code. If you prefer, you can also build the application yourself by following the instructions below.


Updates

The app automatically checks for new versions every time it is launched. Additionally, you can manually trigger a check for updates from the "About" page.

If a new version is available, you have two options:

  1. Install Now: If you choose to update the app instantly, it will download and install the update immediately. Once the update is installed, the app will automatically restart itself, ensuring you have the latest version.

  2. Install Later: If you prefer to install the update at a later time, the app will remember the pending update. On the next app launch, it will automatically install the update before starting. This allows you to continue using the app without interruptions and update it at your convenience.

To manually update the app, you can follow these steps:

  • Uninstall the old version of the app from your system.
  • Visit the releases section on GitHub.
  • Download the latest version of the app.
  • Install the downloaded version on your system.

Development Setup

Prerequisites

  • Node.js (version 16.15.1^)
  • npm (version 8.11.0^)

Clone the Repository

git clone https://github.com/SoBo7a/MSFS-Events-Calendar-Viewer.git
cd msfs-events-calendar-app

Install Dependencies

npm install

Compiles and hot-reloads for development

npm run electron:serve

Compiles and minifies for production

npm run electron:build

Compiling, Minifying, and Creating a New GitHub Release

  • First, you'll need to create a GitHub Access-Token if you haven't already. This token will be used to authenticate your app and enable the release creation process.
  • Once you have your GitHub Access Token, create a new file named .env in the root directory of your project.
  • Open the .env file and add the following line, replacing <YOUR_ACCESS_TOKEN> with your actual GitHub Access Token:
GH_TOKEN=<YOUR_ACCESS_TOKEN>
  • Save the .env file.

  • Run the following command in your terminal or command prompt:

npm run electron:deploy

This command will compile and minify your app for production and automatically create a new GitHub release.

  • Once the release process is complete, your new release will be available on the GitHub repository's releases page.

Customize Configuration

For customizing the Vue configuration, refer to the Configuration Reference Vue.

For customizing the Electron configuration, refer to the Configuration Reference Electron.


Contributing

Contributions are very welcome!


Warranty

This program comes with ABSOLUTELY NO WARRANTY.


Support

For any questions or issues, please reach out to the project maintainers or open an issue in the issue tracker.


License

This project as a whole is licensed under the GPL License. Individual files may have a different, but compatible license.