Document Windows developer setup for building the plugin

Abierto Apto para principiantes
  • ¿Algo no está bien?
#259 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
76/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
rust
Área
devtools, documentation

Línea de trabajo

Lee la tabla „Prerequisites“ del README y decide si añadir allí una sección de configuración para desarrolladores de Windows o crear docs/windows-setup.md y enlazarla desde allí. Ordena los pasos proporcionados para configurar Windows, con comandos que puedan usarse desde cmd y una comprobación después de cada paso; conserva las advertencias sobre los comandos específicos del shell, PATH y el cierre de X-Plane. El trabajo estará terminado cuando un desarrollador pueda seguir la guía y verificar que cada herramienta está disponible.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

area:docs area:xplane-plugin documentation needs-triage

Problem

Once #258 exists the lab PCs no longer need the build toolchain, but anyone changing the plugin or baton still does. The README's Prerequisites table names the tools without saying how to install them on Windows. These are what we had to work out on the lab PC on 2026-10-29:

  • mingw-w64. Install MSYS2 (winget install MSYS2.MSYS2), then run pacman -S --needed mingw-w64-x86_64-gcc from the MSYS2 MINGW64 shell. pacman is not recognised in cmd or PowerShell. We chose the MINGW64 package over UCRT64 because Rust's x86_64-pc-windows-gnu target uses the same msvcrt runtime; that reasoning has not been tested against UCRT64.
  • PATH. Add C:\msys64\mingw64\bin to the user Path, not C:\msys64\usr\bin, which would put MSYS2's own Python ahead of the real one. Open a new terminal afterwards.
  • Meson and Ninja. pip install puts them in Python's Scripts folder, which is often not on PATH, giving 'meson' is not recognized. python -m pip show -f meson shows where they went.
  • Compiler selection. Set CC=gcc and CXX=g++ before the first meson setup so Meson cannot pick MSVC. The syntax depends on the shell: set CC=gcc in cmd, $env:CC="gcc" in PowerShell. The PowerShell form in cmd fails with The filename, directory name, or volume label syntax is incorrect.
  • Rust target. Run rustup target add x86_64-pc-windows-gnu (already in the README).
  • Installing a rebuilt plugin. Close X-Plane first, since it locks the .xpl.
  • Where to look when it does not connect:
    • %TEMP%\baton_debug.log
    • Log.txt in the X-Plane folder
    • Plugins > Plugin Admin, to untick and re-tick the plugin (the X-Plane 12 menu bar stays hidden until the mouse reaches the top edge)

Proposal

A "Windows developer setup" section in the README, or docs/windows-setup.md linked from it, with the steps above in order, every command given for cmd, and a check after each step (gcc --version, meson --version, and so on).

Lenguaje dominante
Python
Estrellas
4
Forks
9
Merge medio
4 d 17 h
PR fusionados (30 d)
7

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de oss-slu/PilotDataSynchronization

Todos los issues de oss-slu/PilotDataSynchronization

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.