README
¶
vice
A fun folly writing an ATC simulator. See the vice website for more information and documentation about how to use vice.
Building vice
To build vice from scratch:
- First make sure that you have a recent go compiler installed: (go compiler downloads)
- Make sure that you have git lfs installed and run
git lfs install - Clone the vice repository to a folder on your computer. Note that you must use the
--recursiveflag so that you also check out submodules that vice requires:
$ git clone --recursive https://github.com/mmp/vice.git
If you accidentally clone vice without using --recursive (or to update the source tree after a new submodule has been added,
run git submodule update --init --recursive.
Windows
To build vice, you must also have the mingw64 compiler installed. Make sure
that your PATH environment variable includes the mingw64 bin directory.
Next, make sure that SDL is installed on your system. You may build it from source, though installing prebuilt binaries is easier. You can download prebuilt binaries from the libsdl releases page.
You will then need to set the following environment variables, with INSTALL
in the following replaced with the directory where you installed SDL2-devel:
CGO_CFLAGS:'-I INSTALL/SDL2-2.24.0/x86_64-w64-mingw32/include'CGO_CPPFLAGS:'-I INSTALL/SDL2-2.24.0/x86_64-w64-mingw32/include'CGO_LDFLAGS:'-L INSTALL/SDL2-2.24.0/x86_64-w64-mingw32/lib'
To build vice, run the command ./build.bat from a command shell in the repository directory.
Mac OSX
If you have homebrew installed, running brew install sdl2 will install SDL2. Otherwise, consult your package manager
documentation or install SDL from source.
From a command shell in the repository directory, run ./build.sh to build a vice executable.
Linux
On Ubuntu, sudo apt install xorg-dev libsdl2-dev will install the necessary libraries.
Then, from a command shell in the repository directory, run ./build.sh to
build a vice executable.
Vulkan
For better speech to text performance, you can compile vice with vulkan support if you have a vulkan compatible gpu.
On Ubuntu, in addition to the above dependencies, install libvulkan-dev and then run ./build.sh --vulkan.
Docker
Docker can be used to build a binary without installing build time dependencies. To build via docker run make docker.
Vice will be compiled in a container and then the resulting binary will be copied to your local machine.
Release Builds
For vice releases, there are a few more steps in the build process so that the executable has an icon and that OSX builds are universal binaries that run on both Intel and Apple CPUs. See the scripts in the osx and windows directories for details. See also the github workflow for the Windows build for details about how the Windows vice installer is created.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package autowhisper provides a simple cross-OS API over whisper.cpp Go bindings.
|
Package autowhisper provides a simple cross-OS API over whisper.cpp Go bindings. |
|
cmd
|
|
|
bundleresources
command
|
|
|
crc2vice
command
|
|
|
dat2vice
command
|
|
|
importfixpairs
command
cmd/importfixpairs/main.go Copyright(c) 2022-2026 vice contributors, licensed under the GNU Public License, Version 3.
|
cmd/importfixpairs/main.go Copyright(c) 2022-2026 vice contributors, licensed under the GNU Public License, Version 3. |
|
importflights
command
|
|
|
importroutes
command
|
|
|
scraperoutes
command
scraperoutes maintains resources/scraped-routes.json, the database of recently filed routes that route selection consults for city pairs the FAA databases don't cover.
|
scraperoutes maintains resources/scraped-routes.json, the database of recently filed routes that route selection consults for city pairs the FAA databases don't cover. |
|
stteval
command
cmd/stteval evaluates the unreviewed transmissions in cmd/sttreview's queue against the current STT decoder.
|
cmd/stteval evaluates the unreviewed transmissions in cmd/sttreview's queue against the current STT decoder. |
|
sttreview
command
|
|
|
sttsim
command
cmd/sttsim provides STT debugging utilities.
|
cmd/sttsim provides STT debugging utilities. |
|
stttest
command
cmd/stttest runs a single STT test case from a JSON file.
|
cmd/stttest runs a single STT test case from a JSON file. |
|
updatesay
command
|
|
|
vice
command
|
|
|
viceserver
command
|
|
|
wxgridviz
command
|
|
|
wxingest
command
|
|
|
wxpackage
command
|
|
|
wxscrape
command
|
|
|
Package enroute emulates the slice of the enroute host computer (ERAM) that vice needs: given a flight's route and a simple trajectory model, derive the coordination fix at which it crosses the boundary between the center and one of its TRACONs, the way the host would when sending the flight plan to STARS; all real ERAM background processing is out of scope.
|
Package enroute emulates the slice of the enroute host computer (ERAM) that vice needs: given a flight's route and a simple trajectory model, derive the coordination fix at which it crosses the boundary between the center and one of its TRACONs, the way the host would when sending the flight plan to STARS; all real ERAM background processing is out of scope. |
|
TODO: 1.
|
TODO: 1. |
|
pkg/platform/imgui.go Copyright(c) 2022-2024 vice contributors, licensed under the GNU Public License, Version 3.
|
pkg/platform/imgui.go Copyright(c) 2022-2024 vice contributors, licensed under the GNU Public License, Version 3. |
|
sim/aircraft_classes.go Copyright(c) 2022-2026 vice contributors, licensed under the GNU Public License, Version 3.
|
sim/aircraft_classes.go Copyright(c) 2022-2026 vice contributors, licensed under the GNU Public License, Version 3. |
|
Commands defined in chapter 3 of the TCW Operator Manual
|
Commands defined in chapter 3 of the TCW Operator Manual |
|
Package stt provides a local algorithmic speech-to-command parser for ATC transcripts, replacing the LLM-based approach with fast fuzzy matching.
|
Package stt provides a local algorithmic speech-to-command parser for ATC transcripts, replacing the LLM-based approach with fast fuzzy matching. |