.. _stdlib_linux:

=================
Linux Setup Guide
=================

Native Linux build is still a work in progress. If you want to launch EdenSpark on Linux, you can use ``wine``.

Prerequisites
=============

Install ``wine``.

Note that some distributions, Ubuntu included, have an outdated ``wine`` package in their repos, so using `an official guide <https://gitlab.winehq.org/wine/wine/-/wikis/Download>`_ is recommended.

On Arch you can use

.. code-block:: bash

   sudo pacman -S wine

EdenSpark doesn't need any other components like ``wine-mono``, so there is no need to install anything else.

To initialize wine prefix, run

.. code-block:: bash

   wineboot --init

The explicit initialization is unnecessary as it will be performed at first ``wine`` launch,
but this will allow to configure ``wine`` pre-installation (see below).
From now on we will assume that default wine prefix path ``~/.wine`` is used, and user directory is the same as Linux ``$USER``.

Installation
============

EdenSpark holds some data in ``Documents`` directory, which by default is linked to Linux directory ``~/Documents``.
If you wish to keep ``wine`` data completely separate, make sure to remove the link:

.. code-block:: bash

   winecfg

Under "Desktop Integration > Folders" remove desired links.

Download EdenSpark installer `here <https://gdn.gaijin.net/launcher/current.php?id=EdenSparkUpdater>`_.
Launch it with

.. code-block:: bash

   wine edenspark_updater_1.0.0.14.exe

and follow the installation process normally.

Configuration
=============

EdenSpark supports Vulkan, so in the updater you'll need to switch *Render* dropdown from ``auto`` to ``vulkan``.
Unfortunately in our testing we found that the updater rendering is buggy, which causes the drop down to not work.
In such case, you can switch render engine manually:

Open ``~/.wine/drive_c/users/$USER/AppData/Local/EdenSpark/eden.config.blk``. Under ``video`` block, set ``driver:t="vulkan"``

Running
=======

You can start EdenSpark using the desktop icon created during installation
(at ``~/.wine/drive_c/users/$USER/Desktop`` or ``~/Desktop`` if link wasn't removed).
If you chose not to create the icon, you can always launch using


.. code-block:: bash

   wine "C:/users/$USER/AppData/Local/EdenSpark/launcher.exe"


Further implovements
====================

EdenSpark allows you to open a VS Code project of a game.
If you wish to use this feature, you'll need to "install" VSCode to ``wine``.
Here's how you can do it: create this script named ``Code.exe`` somewhere in Windows' ``%PATH%``, for example ``~/.wine/drive_c/windows``

.. code-block:: bash

   #!/bin/bash

   code "$(winepath -u "$1")"

Do not forget to ``chmod +x`` it.