Skip to content

Installation

Jump to bottom
Alex Nord edited this page Apr 28, 2026 · 2 revisions

✈️ SimpleSim Install Guide

✅ What's needed or required?

Required for the Flask/Python backend

Requirement Needed for
Git Clone the repo
Python 3 Run the backend
pip Install Python packages
Python venv Keep backend dependencies isolated
Discord Developer App Discord OAuth login
Discord Client ID Backend auth
Discord Client Secret Backend auth
Discord Redirect URI OAuth callback
SECRET_KEY Flask sessions
ALLOWED_DISCORD_IDS Restrict who can log in

Required for SimpleSimConnector

Requirement Needed for
Windows Runs the connector EXE
Microsoft Flight Simulator 2020 or 2024 SimConnect telemetry source
Bundled SimpleSimConnector/ folder Contains the EXE, DLLs, and config
Running backend Connector sends telemetry to backend
Correct connector.ini Points connector at backend

Included connector files

Keep these files together:

SimpleSimConnector/
├─ SimpleSimConnector.exe
├─ connector.ini
├─ SimConnect.dll
└─ Microsoft.FlightSimulator.SimConnect.dll

Do not move only the .exe.

The DLLs must stay beside the EXE.

🧠 What each part does

Flask/Python backend

The backend:

  • serves the web app
  • handles Discord login
  • stores flight history
  • receives SimConnect telemetry
  • powers the dashboard
  • writes to the local SQLite database

Default URL:

http://localhost:5000

Telemetry endpoint:

http://127.0.0.1:5000/api/telemetry

SimpleSimConnector

SimpleSimConnector:

  • runs on Windows
  • waits for MSFS
  • connects to SimConnect
  • reads aircraft telemetry
  • sends telemetry to the Flask backend
  • can optionally install MSFS autostart

Default connector backend URL:

http://127.0.0.1:5000/api/telemetry

🚀 How to install the Flask/Python backend from scratch

1. Clone the repo

git clone https://github.com/Anord-cc/simplesim.git
cd simplesim

2. Create a Discord OAuth app

Open:

https://discord.com/developers/applications

Create an app, then add this OAuth redirect URI:

http://localhost:5000/auth/callback

Copy these values:

DISCORD_CLIENT_ID
DISCORD_CLIENT_SECRET

3. Create the backend .env file

From the repo root:

copy backend\.env.example backend\.env
notepad backend\.env

Use this as the local setup:

DISCORD_CLIENT_ID=your_discord_client_id
DISCORD_CLIENT_SECRET=your_discord_client_secret
DISCORD_REDIRECT_URI=http://localhost:5000/auth/callback

SECRET_KEY=replace_with_a_long_random_secret
ALLOWED_DISCORD_IDS=123456789012345678

SIMCONNECT_CALLSIGN=SIMCONNECT
SIMCONNECT_DEP=
SIMCONNECT_ARR=
SIMCONNECT_AIRCRAFT=

SIMBRIEF_USERNAME=
SIMBRIEF_USERID=

PASSKEY_RP_ID=localhost
PASSKEY_ORIGIN=http://localhost:5000
PASSKEY_RP_NAME=VATSIM HeatTracker

TRACKER_POLL_SECONDS=20
TRACKER_MIN_INSERT_SECONDS=10
SIMCONNECT_STALE_SECONDS=30

Generate a proper SECRET_KEY:

python -c "import secrets; print(secrets.token_hex(32))"

Paste the generated value into:

SECRET_KEY=

4. Add your Discord user ID

Set:

ALLOWED_DISCORD_IDS=your_discord_user_id

For multiple users:

ALLOWED_DISCORD_IDS=123456789012345678,987654321098765432

Without this, login may succeed but access will be blocked.

5. Install backend dependencies

python -m pip install --upgrade pip
pip install -r requirements.txt

Backend packages installed:

flask
flask-cors
requests
python-dotenv
webauthn
SimConnect

6. Start the backend

From the repo root:

python backend\app.py

Open:

http://localhost:5000

8. Backend login flow

1. Open http://localhost:5000
2. Sign in with Discord
3. Make sure your Discord ID is allowlisted
4. Link your VATSIM CID if needed
5. Open the dashboard

Dashboard:

http://localhost:5000/dashboard

🛩️ How to install SimpleSimConnector from scratch

This uses the bundled connector. No compiling needed.

1. Go to the connector folder

From the repo root go to SimpleSimConnector:

You should see:

SimpleSimConnector.exe
connector.ini
SimConnect.dll
Microsoft.FlightSimulator.SimConnect.dll

2. Check connector.ini

Open:

notepad connector.ini

Default config:

# Simple Sim Connector settings
backend_url=http://127.0.0.1:5000/api/telemetry

local_api_enabled=true
local_api_port=4789

write_local_telemetry_file=true

wait_for_sim=true
auto_exit_with_sim=true
auto_exit_delay_seconds=10
sim_process_names=FlightSimulator2024,FlightSimulator

For local use, keep:

backend_url=http://127.0.0.1:5000/api/telemetry

3. Start the backend first

From the repo root:

python backend\app.py

Leave it running.

4. Start Microsoft Flight Simulator

Start one of these:

Microsoft Flight Simulator 2024
Microsoft Flight Simulator 2020

The connector waits for these process names:

FlightSimulator2024
FlightSimulator

5. Run SimpleSimConnector

From the repo root:

.\SimpleSimConnector\SimpleSimConnector.exe

Or from inside the connector folder:

.\SimpleSimConnector.exe

6. Confirm connector status

The connector window should show:

POST: http://127.0.0.1:5000/api/telemetry
Local API: http://0.0.0.0:4789/telemetry
MSFS connection status
Latest telemetry

When MSFS is running and SimConnect is available, telemetry should start flowing into the backend.

🔁 Optional: install MSFS autostart

You can install autostart from the connector UI.

Or run:

.\SimpleSimConnector\SimpleSimConnector.exe --install-autostart

To remove autostart:

.\SimpleSimConnector\SimpleSimConnector.exe --uninstall-autostart

Clone this wiki locally