-
Notifications
You must be signed in to change notification settings - Fork 69
Linux Setup Guide
GNU/Linux is the most compatible and recommended operating system to use with Vanilla, and thankfully it is available on many of Vanilla's target devices such as the Steam Deck and Nintendo Switch.
For the most part, any modern Linux PC should be able to run Vanilla out of the box, however you should double check the Wireless Compatibility page to see if the wireless hardware on your computer is known to be compatible or not.
The following are notes on specific platforms/situations that should be taken into account:
The full screen state can be toggled in the Settings. However, on some setups (e.g. embedded systems), it may be preferable to start Vanilla in full screen or windowed mode without having to change anything in the config. The following command-line arguments can be used to override the setting in the config:
-w Force Vanilla to launch in windowed mode
-f Force Vanilla to launch in full screen mode
For example, to force Vanilla to launch in windowed mode, you can run:
./vanilla -w
Note
When running in full screen, the cursor is hidden to best accommodate devices with touch screens. The UI can still be navigated using button controls.
Warning
Following this guide has security risks. Make sure you read through everything before deciding whether to do this or not.
Connecting to the Wii U as a gamepad requires obtaining low-level access to the wireless hardware, which requires vanilla-pipe to run as root. By default, running a program as root on Linux requires the user to enter their password (or the password of an administrator), which can be inconvenient and irritating when trying to play games, especially on touch-based platforms where a keyboard is not readily available and/or typing is inconvenient.
To solve this, Vanilla can optionally install a Polkit rule that allows vanilla-pipe to run as root without password entry. Note that there are inherent security risks with allowing an executable to run as root without user intervention, and while vanilla-pipe doesn't do anything explicitly dangerous, we cannot make any security guarantees when doing this.
In order to install the Polkit action, enter Vanilla's "Settings" screen, and press "Enable Root Password Skip".
Note
Only try this if the gyroscope does not function. Vanilla will try to automatically detect and setup the gyroscope.
While the gyroscope should work fine out of the box, you may need to add a udev rule to /etc/udev/rules.d/70-gyro.rules to get the gyroscope working properly.
SUBSYSTEM=="input", ENV{ID_INPUT_ACCELEROMETER}=="?*", TAG+="uaccess"
After adding the rule, the gyroscope should function.
While Vanilla is technically capable of running on Raspberry Pis, Pis frequently use embedded Broadcom wireless hardware which is FullMAC, and therefore unable to connect to a Wii U. If you attach a secondary USB wireless adapter that is compatible, Vanilla should run fine.
Similarly to the Raspberry Pi, the Nintendo Switch uses an embedded FullMAC Broadcom wireless adapter which is incapable of connecting to a Wii U on its own in the stock firmware. However, since the Switch is a significant target device, there are now firmware patches for its wireless adapter (BCM4356) you can install to run Vanilla without a secondary USB wireless adapter. The patches and their installation instructions are located here. The installation process can be complex, so a compatible secondary USB wireless adapter can still be used to facilitate a connection.
The Steam Deck has its own dedicated page on this wiki for further details about setting it up.