linux_setup []

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Setting up RomVault on Linux ======
RomVault is designed as a Windows application, but it will run on many Linux distros using ''mono''. The instructions below outline the basic steps to initially setup RomVault on Linux using the Ubuntu distro as an example.

<WRAP important>There may be Linux and mono specific bugs. Please refer to the [[https://romvault.convas.io/bugs?tags=Linux|Bugs & Known Issues]] page and filter for the Linux tag for more details. Please join the [[https://discord.gg/fVJQPA8|ROMVault Discord server]] to report any new bugs.</WRAP>

===== Install Mono =====
  * Install the ''**mono-complete**'' package appropriate for your version of your Linux distro.
    * On Arch and derivatives, the ''**mono**'' package is correct.

===== Create a Launcher Shortcut =====
The RomVault application is designed to write configuration files and its Cache file to the same directory as the executable. Its important to launch RomVault using mono from the same directory as the RomVault executable. You may find it helpful to create a launcher shortcut to do this.

  - Open a text editor
  - Paste the following into your text file:  \\ \\ <code>
[Desktop Entry]
Type=Application
Terminal=false
Hidden=false
Name=ROMVault
Path=/home/gordonj/Desktop/ROMVault
Exec=mono /home/gordonj/Desktop/ROMVault/ROMVault3.exe
Icon=/home/gordonj/Desktop/ROMVault/romvault.ico
</code>
  - Modify the ''Path'', ''Exec'', and ''Icon'' lines as needed
  - Save the file with the name ''ROMVault.desktop'' and save it to your desktop
  - Right click the file and select **Properties**
  - Select the **Permissions** tab
  - Enable **Allow executing file as program**
  - Close the Properties window
  - Right click the file and select **Allow Launching**

<WRAP info>RomVault does not come packaged with a separate icon file. You can use your own .png or .ico file for your launcher shortcut image. The ROMVault [[https://raw.githubusercontent.com/RomVault/RVWorld/master/ROMVault/chip.ico|chip icon]] is available on GitHub.</WRAP>

===== Launch RomVault =====
You can now Launch RomVault by double clicking your newly created shortcut. 

Alternately, you can launch RomVault via the command line with ''mono'' from the RomVault executable directory:
  - Open the **Terminal** application
  - Navigate to your RomVault executable directory
  - Launch with ''mono ./ROMVault3.exe''

===== Troubleshooting Missing Text =====
There are many combinations of Linux distros, ''mono'' versions, and system setups that could cause certain display issues like missing text or images. If there is text missing from certain areas of the application, particularly DatVault, then the most likely root cause font compatibility.

If you have missing text after upgrading to the latest stable version of ''mono'', then you can try to globally remap specific fonts that RomVault uses:
  - From console run the commands ''fc-match Arial'' then ''fc-match "Microsoft Sans Serif"'' to check if those fonts are installed.
  - If the fonts are not installed, then choose suitable fonts you would like to use. For this example we will use "Liberation Sans" for both.
  - See the sections below for details about how to remap the fonts.
  - **OPTIONAL**: Launch RomVault with ''GTK_DATA_PREFIX= mono ROMVault36.exe'' which will force light mode.
  
==== Using Font Manager ====
  - Install the ''font-manager'' package appropriate for your version of your Linux distro.
  - Open ''font-manager'' and click on "Preferences".
  - Navigate to "Substitutions" on the left-hand side.
  
Repeat the following steps for both "Microsoft Sans Serif" and "Arial":
  - Press the "+" button at the top and enter the font family name.
  - Press the "+" button to the right and enter "Liberation Sans" for the substitute family.
  - Ensure that the dropdown next to the substitute family is set to "prefer".

==== Manual Remapping ====
  - Modify the file ''/etc/fonts/local.conf'' with the following:  \\ \\ <code>
<!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd">
<fontconfig>
<alias>
    <family>Microsoft Sans Serif</family>
    <prefer>
        <family>Liberation Sans</family>
    </prefer>
</alias>
<alias>
    <family>Arial</family>
    <prefer>
        <family>Liberation Sans</family>
    </prefer>
</alias>
</fontconfig>
</code>


<WRAP tip>If RomVault does not start properly or if certain features like DatVault do not work, then the issue may be related to a WinForms style that is deprecated in ''mono''. If you run into this issue, try setting the following variable when launching the application:
''$ MONO_WINFORMS_XIM_STYLE=disabled mono ROMVault3.exe''</WRAP>