Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: remote simbridge documentation #741

Closed
wants to merge 2 commits into from
Closed

feat: remote simbridge documentation #741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09803ba
feat: remote simbridge documentation
Valastiri Feb 19, 2023
a1c8e68
add warning for advanced users
Valastiri Feb 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/simbridge/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ require fewer extra steps before launching into your flights.

## Feature Guides

| Feature | Status |
|:-----------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------:|
| [Terrain Display](simbridge-feature-guides/terrain.md) | In [Development](../fbw-a32nx/fbw-versions.md#development-version-recommended) Version |
| [MCDU Remote Display](simbridge-feature-guides/remote-displays/remote-mcdu.md) | Available in [All Versions](../fbw-a32nx/fbw-versions.md) |
| [Company Routes Support](simbridge-feature-guides/coroute.md) | Available in [All Versions](../fbw-a32nx/fbw-versions.md) |
| [flyPad Local Charts](../fbw-a32nx/feature-guides/flypados3/charts.md#local-files) | Available in [All Versions](../fbw-a32nx/fbw-versions.md) |
| Remote Displays | Work in Progress |
| Feature | Status |
|:----------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------:|
| [Terrain Display](simbridge-feature-guides/terrain.md) | In [Development](../fbw-a32nx/fbw-versions.md#development-version-recommended) Version |
| [MCDU Remote Display](simbridge-feature-guides/remote-displays/remote-mcdu.md) | Available in [All Versions](../fbw-a32nx/fbw-versions.md) |
| [Company Routes Support](simbridge-feature-guides/coroute.md) | Available in [All Versions](../fbw-a32nx/fbw-versions.md) |
| [flyPad Local Charts](../fbw-a32nx/feature-guides/flypados3/charts.md#local-files) | Available in [All Versions](../fbw-a32nx/fbw-versions.md) |
| Remote Displays | Work in Progress |
| Remote SimBridge | In [Development](../fbw-a32nx/fbw-versions.md#development-version-recommended) Version |

!!! warning "Important Notes"
Please keep SimBridge updated at all times regardless of the version of aircraft you are currently flying!
Expand Down
3 changes: 2 additions & 1 deletion docs/simbridge/simbridge-feature-guides/.pages
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ nav:
- Remote Displays: remote-displays
- Terrain Display: terrain.md
- Company Routes: coroute.md
- Local Files: local-files.md
- Local Files: local-files.md
- Remote SimBridge: remote-simbridge.md
24 changes: 24 additions & 0 deletions docs/simbridge/simbridge-feature-guides/remote-simbridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Remote SimBridge

This guide details how to run SimBridge on a remote machine and connect to it from your local machine (where your simulator is running).

!!! warning "For Advanced Users"
This guide is intended for advanced users who are familiar with networking and have a good understanding of how to configure their network to allow remote connections. If you are not familiar with networking, we recommend you do not attempt to follow this guide.

While the benefits of running SimBridge on an external machine are few it would allow to users offload some resources from your local machine. If you encounter any issues please resort to this
guide or use SimBridge on your local machine (the same one with MSFS running). Contact our Discord support if you do wish to troubleshoot this feature.

## PC Requirements

- FlyByWire Installer running on the remote machine - See [Starting SimBridge](../install-configure/start-simbridge.md)
- SimBridge running on the remote machine - See [Starting SimBridge](../install-configure/start-simbridge.md)

## Simulator Requirements

[WIP]

## Troubleshooting

[WIP]

## Known Issues (section may not be required) [WIP]