vice

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 --recursive flag 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.