Skip to content

Document v0.1.0 release notes and first use #1

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

Merged
devigned merged 2 commits into from
Nov 4, 2026
Merged

Document v0.1.0 release notes and first use #1

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
603f718
Document v0.1.0 installation and first use
devigned Nov 4, 2026
cb46a24
Draft v0.1.0 release notes and revise documentation prose
devigned Nov 4, 2026
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
180 changes: 96 additions & 84 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,96 +1,108 @@
# VX Bridge

**One ProTee VX connection. Your choice of golf simulator.**

For golfers using a ProTee VX, VX Bridge sends shots from **ProTee Labs** to
**Infinite Tees** or **GSPro OpenAPI** on the same PC. Choose the game from the
small icon near the Windows clock; your choice is remembered. Labs still manages
your launch monitor, and the game handles ball flight. You don't need to swap
connector files whenever you change games.

## Get started

You'll need **Windows x64**, an activated **ProTee VX with Labs already working**,
and a **licensed Infinite Tees or GSPro game on the same PC**. For GSPro, use its
public **OpenAPI / APIv1 Connect** application, not the native VX receiver.
VX Bridge does not include a game or replace your existing licenses.

**Public source; no public installer release yet.** An earlier installer candidate
passed hosted Windows checks for installation, damaged-file repair, one
controlled version upgrade, full uninstall and recovery by uninstall/reinstall.
That does not qualify this public bootstrap or a rebuilt binary. Interactive
setup, Windows sign-in and live Labs/game behavior for the current source,
including GSPro and game switching, still need testing. Earlier Infinite Tees
trials do not qualify it as a ready-to-play release.

For an approved pilot build:

1. **Choose the approved installer ZIP from the pilot organizer.** Use
**Extract All**, then keep matching `setup.exe` and `bridge.msi` in the
extracted folder with the accompanying files. Choose the installer ZIP,
not the application ZIP or MSI alone; see
[filenames and which files to use](docs/INSTALL.md#choose-the-right-files).
2. **Close any existing receiver safely.** In ProTee Labs, use **Game Options >
Disconnect**, then close that receiver through its own controls. Never run
two receivers or overwrite the vendor's `GSPconnect.exe`.
3. **Open `setup.exe` and choose Install.** Run it normally as your Windows user,
not as administrator. Don't double-click `bridge.msi` to install it.
**Auto-launch on Windows Startup** is optional and off on a fresh install:
"Starts when you sign in to Windows." After successful setup, **Start bridge**
opens it once; **Not now** lets you open **VX Bridge** from Start later.
4. **Open your game and choose it in VX Bridge.** Right-click the bridge icon
near the clock (check hidden icons too), then choose **Use Infinite Tees** or
**Use GSPro OpenAPI**. For GSPro, open its OpenAPI Connect application as well.
**Standby (discard shots)** keeps Labs connected but sends shots to neither game.
5. **Connect in ProTee Labs and check the game.** Use Labs' normal Connect action
if needed. The menu should show Labs connected and the selected game
**Connected (transport only)**. Confirm the game is in a playable scene:
a connection alone does **not** mean it is ready for your next shot.

Neither launch option opens Labs or the game, connects Labs, or changes your
saved game choice. For another day, open VX Bridge and your game, check the tray
choice, and connect Labs.

**When finished:** use **Game Options > Disconnect in ProTee Labs**, then
**Quit** in VX Bridge. Quit waits while Labs is still attached; don't force it
closed with Task Manager.

Need help? [Installation and repair](docs/INSTALL.md),
[everyday use](docs/USAGE.md) and the [troubleshooting FAQ](docs/FAQ.md) cover the
next steps. If you see **Repair required**, use VX Bridge Setup; a failed upgrade
may need a complete uninstall and fresh install rather than Repair alone.
VX Bridge forwards shot data from ProTee Labs to Infinite Tees or GSPro OpenAPI
on the same Windows PC. Select one game from the icon near the clock. Labs
controls the launch monitor; the game calculates ball flight.

## Requirements

- Windows x64.
- An activated ProTee VX with ProTee Labs already working.
- A licensed Infinite Tees or GSPro installation on the same PC.

For GSPro, use its public **OpenAPI / APIv1 Connect** application, not the native
VX receiver. VX Bridge does not supply a game or replace an existing license.
v0.1.0 is an early release; read [Limits](#limits) before installing.

## Install

**[Download the v0.1.0 installer ZIP](https://github.com/devigned/vx-bridge/releases/download/v0.1.0/vx-bridge-installer-windows-amd64-v0.1.0-5401cf26d19238b04ba3dbb8ecfa60442616ca79.zip).**
Use this ZIP, not the application-only ZIP, separate MSI or **Source code**
downloads. See the [release notes](docs/releases/v0.1.0.md) for the initial
release's features, contributors and files.

1. In ProTee Labs, select **Game Options > Disconnect**. Close any existing
receiver through its own controls. Do not run two receivers or replace the
vendor's `GSPconnect.exe`.
2. Right-click the downloaded ZIP and select **Extract All**. Open the extracted
folder. Keep all nine files together, including `setup.exe` and `bridge.msi`.
Do not run Setup from inside the ZIP or mix files from different builds.
3. Open `setup.exe` as the Windows user who will use the bridge, not as
administrator. Select **Install**. Do not double-click `bridge.msi`.
4. Leave **Auto-launch on Windows Startup** off unless the bridge should open
when you sign in. It is off on a fresh install.
5. Wait for Setup to report success. At **Start the bridge now?**, select
**Start bridge** to open it once, or **Not now** to open **VX Bridge** from
Start later. Starting it once does not enable auto-launch.

If Windows blocks Setup, stop and [report the warning](https://github.com/devigned/vx-bridge/issues).
Do not disable security protections or bypass the warning.

## First use

1. Open the game and enter a playable practice scene. For GSPro, also open
**OpenAPI / APIv1 Connect**.
2. Open **VX Bridge** from Start if it is not running. Find its icon near the
Windows clock; check the hidden-icons arrow if necessary.
3. Right-click the icon. Select **Use Infinite Tees** or **Use GSPro OpenAPI**.
A checkmark shows the applied choice. The bridge remembers it for next time.
4. Use ProTee Labs' normal Connect action if needed. The bridge does not open
Labs or the game, or connect Labs for you.
5. Check the bridge menu. Labs should be connected and the selected game should
show **Connected (transport only)**. Then check the game itself before
swinging. A data connection does not establish that the game is ready.

For later sessions, open the game and bridge, check the selected game, then
connect Labs. Wait for each shot's visible result before the next swing.

## End a session

In ProTee Labs, select **Game Options > Disconnect**. Then select **Quit** in
VX Bridge. Quit waits while Labs is attached. Do not force the bridge closed
with Task Manager.

## Troubleshooting

| Symptom | Action |
|---|---|
| No bridge icon | Check hidden icons near the clock. Open **VX Bridge** from Start, not another downloaded copy. |
| No connection | Run one receiver. Check the selected game and open it. For GSPro, open **OpenAPI / APIv1 Connect** too. See [connection help](docs/FAQ.md#protee-labs-wont-connect). |
| **Repair required** | Open **VX Bridge Setup** from Start and select **Repair / Reinstall**. If it fails, follow the [recovery guide](docs/INSTALL.md#maintenance-and-repair-required). Do not replace files manually. |

Do not hit shots to trigger reconnection. If delivery is uncertain, check the
game before swinging again: it may have received the shot.

## Change games without changing the connection

Only your selected game receives shots. Starting another game does not select it
automatically or send shots to both games. Stop swinging, let the visible result
finish, choose the other game, and wait for switching to finish before checking
that game.
Stop swinging and let the visible result finish. Select the other game and wait
for switching to finish. Check that game before resuming.

Shots missed during an outage, switching or Standby are **lost, not saved for
later or replayed**. If delivery is uncertain, the game may already have received
the shot; check before swinging again. VX Bridge doesn't invent missing
measurements, success replies or game readiness.
Only the selected game receives shots. Opening a game does not select it.
**Standby (discard shots)** keeps Labs connected but sends to neither game.
Shots missed during switching, an outage or Standby are lost, not saved or
replayed.

Local logs leave out shot measurements and device/player identifiers. Nothing
is uploaded automatically.
## Limits

## Help make VX Bridge better
v0.1.0 passed automated build and file checks. Interactive installation, Windows
sign-in, installer servicing and live Labs/game use, including GSPro and game
switching, remain unqualified for these binaries. Earlier observations used
different builds; see [qualification](docs/technical/QUALIFICATION.md).

You don't need a launch monitor to improve the instructions, report a confusing
step or work on automated tests. Start with the [contribution guide](contributors.md)
for reporting a bug, setting up a checkout and submitting a focused change.
The Windows programs and installer are not publisher-signed (Authenticode).
Signed Git commits and tags do not sign those files.

For code work, use the [build and command guide](docs/technical/COMMANDS.md),
[testing guide](docs/technical/TESTING.md) and
[technical manual](docs/technical/README.md). The
[compatibility evidence and remaining gaps](docs/technical/QUALIFICATION.md)
distinguish tested behavior from work still needed before release.
Local logs omit shot measurements and device/player identifiers. Nothing is
uploaded automatically.

## Open-source license
## Documentation and contributions

Original project work is available under the [MIT license](LICENSE), with its
notice and warranty disclaimer. [Third-party notices](THIRD_PARTY_NOTICES.txt)
cover dependencies and reference material; MIT does not license vendor software.
This is an unofficial project, not affiliated with or endorsed by ProTee,
Infinite Tees or GSPro.
Use the [installation guide](docs/INSTALL.md), [everyday guide](docs/USAGE.md) or
[FAQ](docs/FAQ.md) for more detail. The [technical manual](docs/technical/README.md)
covers implementation and testing. Read [Contributing](contributors.md) before
reporting a bug or submitting a change.

Original work uses the [MIT license](LICENSE).
[Third-party notices](THIRD_PARTY_NOTICES.txt) cover dependencies and reference
material, not a license to vendor software. VX Bridge is unofficial and is not
endorsed by ProTee, Infinite Tees or GSPro.
13 changes: 7 additions & 6 deletions contributors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contributing

Help make VX Bridge easier to use and maintain. Documentation, useful bug
reports, regression tests and small fixes are all welcome. You don't need a
launch monitor to improve the guides or run the automated tests.
Contributions may improve documentation, report bugs, add regression tests or
fix code. A launch monitor is not needed to edit the guides or run automated
tests.

## Pick a useful first contribution

Expand All @@ -12,9 +12,10 @@ versions involved. Include the visible tray error and selected game when relevan

Check the [FAQ](docs/FAQ.md) and
[existing issues](https://github.com/devigned/vx-bridge/issues)
before opening a report. This is the public source repository; there is no
published playing release yet. Please don't attach raw captures, real shot data,
device identifiers, account details or full vendor logs.
before opening a report. Include the release version and the visible error.
[v0.1.0](docs/releases/v0.1.0.md) is published but has not been qualified for live
play. Do not attach raw captures, real shot data, device identifiers, account
details or full vendor logs.

For code changes, choose a small issue or discuss the intended behavior first.
Changes to delivery, game readiness, shutdown or installation need particular
Expand Down
43 changes: 26 additions & 17 deletions docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,21 @@

## Where is the installer?

**No public installer or GitHub release is published yet.** Approved pilot
testers should get the reviewed **installer ZIP** from the pilot organizer,
not the application ZIP or MSI alone. Use **Extract All**, keep matching
**`setup.exe` and `bridge.msi` in the extracted folder**, and open Setup.
[Download the public v0.1.0 installer ZIP](https://github.com/devigned/vx-bridge/releases/download/v0.1.0/vx-bridge-installer-windows-amd64-v0.1.0-5401cf26d19238b04ba3dbb8ecfa60442616ca79.zip).
Select **Extract All**, keep all nine files together, and open `setup.exe` from
the extracted folder with matching `bridge.msi` beside it. Do not install the
bare MSI.

The [Releases page](https://github.com/devigned/vx-bridge/releases)
requires private-repository access today. A missing asset isn't a reason to
download a similarly named executable elsewhere. An application-only development
ZIP, source archive or **BUILD ONLY** artifact is not an approved installer.
See [exact filename patterns and which files to use](INSTALL.md#choose-the-right-files).
The application ZIP, source archives and **BUILD ONLY** artifacts are not the
installer. See [file types](INSTALL.md#choose-the-right-files) and
[tested scope](#which-versions-and-features-have-been-checked).

## Windows blocks Setup

Stop and [report the warning](https://github.com/devigned/vx-bridge/issues).
Do not disable security protections or bypass it. The Windows programs and
installer are not publisher-signed (Authenticode). Signed Git commits and tags
do not sign those files.

## ProTee Labs won't connect

Expand Down Expand Up @@ -63,10 +68,10 @@ recovery before swinging. **Standby** deliberately sends to neither game.

## Can I change games without disconnecting Labs?

That is the intended pilot workflow: stop swinging, finish the visible result,
choose the other game and wait for switching to finish. VX Bridge keeps Labs
connected while the current shot response and pending replies finish or time
out. New shots during switching are discarded, not saved for later.
Stop swinging, finish the visible result, select the other game and wait for
switching to finish. VX Bridge keeps Labs connected while the current shot
response and pending replies finish or time out. New shots during switching
are discarded, not saved for later.

If switching is blocked by a Labs connection fault, use normal Labs Disconnect; repeated
choices cannot force it. Live Infinite Tees/GSPro switching still needs testing.
Expand Down Expand Up @@ -119,7 +124,7 @@ doesn't replace the running host; a duplicate notice leaves it alone.

Don't restart Explorer during an attached session just to try to restore an
icon. If the menu remains inaccessible, the separate `vxbridge.exe` control
tool can check status or request normal guarded Quit. Ask the pilot organizer
tool can check status or request normal guarded Quit. Ask a project maintainer
for help or use the [control reference](technical/DESKTOP.md).
Don't launch an extra `GSPconnect.exe` to perform a control command.

Expand All @@ -136,7 +141,7 @@ the bridge. Windows' automatic rollback is enabled, but a failed operation does
not guarantee that the previous version returned.

Keep the bridge stopped. If Repair cannot complete, use **complete Uninstall,
then a fresh Install**. If multiple versions remain, get the pilot organizer's
then a fresh Install**. If multiple versions remain, get a project maintainer's
recorded-version recovery instructions: remove the original recorded old
version, fully uninstall the current version, confirm complete removal, then
install fresh. Removing only one version is not completed recovery.
Expand Down Expand Up @@ -201,6 +206,10 @@ remain on the same PC; network/LAN targets aren't supported.

## Which versions and features have been checked?

v0.1.0 passed automated build and static file checks. Those checks did not run
the installer or product executables. See the [release notes](releases/v0.1.0.md)
and [publication record](technical/QUALIFICATION.md#public-release-publication).

An earlier private installer candidate passed hosted Windows checks for standard-user
installation, damaged-file repair, one controlled version-to-version upgrade,
full removal and explicit uninstall/reinstall recovery after an induced failure.
Expand Down Expand Up @@ -230,8 +239,8 @@ core and source; it is not a promise to upgrade arbitrary older builds.

Start with normal Labs Disconnect and Quit the old copy. Preserve its files and
startup registration until you have separately approved migration instructions.
There is no published installer or verified portable-migration procedure yet;
don't treat this scope decision as permission to install or delete an old copy.
There is no verified portable-migration procedure. Publication of v0.1.0 does
not authorize adopting or deleting an old copy.

## Does uninstall erase my game choice or all installer files?

Expand Down
Loading