@@ -11,34 +11,63 @@ A simple administration web app for managing your Arma 3 server
1111- Upload custom scenarios from your local machine
1212
1313## Installation
14- Before attempting to install this GUI, make sure you've successfully installed SteamCMD and Arma 3 dedicated server.
15- You can follow [ this guide] ( https://community.bistudio.com/wiki/Arma_3_Dedicated_Server ) .
1614
17- After you have your SteamCMD and Arma 3 dedicated server working, either download the GUI jar file or build it from the
18- source using ` gradle assemble ` .
15+ ### Prerequisites
16+ - [ JDK 17] ( https://www.oracle.com/java/technologies/downloads/#java17 )
17+ - [ Docker] ( https://docs.docker.com/engine/install/ ) or own MySQL database
1918
20- In the same path, create a new directory ` config ` and put ` application.properties.EXAMPLE ` inside. Now, delete
21- the extension .EXAMPLE, leaving you with ` application.properties ` . In this file, configure all the necessary properties.
19+ ### Installing SteamCMD
20+ Follow [ this guide] ( https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD ) to install SteamCMD on your
21+ server. After the installation is finished, set the full path to SteamCMD executable in ` application.properties ` . On Linux,
22+ the default path when installing with package manager is ` /usr/games/steamcmd ` .
2223
23- Launch the application: ` java -jar arma3-server-gui.jar ` . Your GUI should now be available to access from the browser
24- on the set port, ` 8080 ` by default.
25-
26- ## Steam Workshop
27- For downloading workshop mods and keeping the server up-to-date, you're going to need a Steam account with
28- a copy of Arma 3, otherwise, these features will not be available.
24+ ### Getting SteamAuth token
25+ If you have Steam Guard 2FA enabled on your Steam account, you're going to need to get a SteamAuth token. To do this,
26+ manually launch SteamCMD with a command line.
2927
30- It's not necessary to have a separate account for downloading the mods and gaming. However, you might encounter some
31- issues such as being disconnected from your Steam account when it's needed for mod download and updating.
28+ Type ` login <your_steam_name> ` and input password when prompted. Then you'll be prompted to input Steam token
29+ which will be sent into your email. Enter it to successfully login and then type ` quit ` to exit the SteamCMD interface.
30+ ** Keep the token for later use** .
3231
33- If your account is protected by Steam Guard 2FA, you can optionally put in the verification token. This token should
34- be delivered to your account's email after the first attempt of updating the server and/or downloading a mod.
32+ ### Configuring the Admin UI app
33+ There is a ` config ` directory bundled with the .jar executable file. In it, you will find ` application.properties.EXAMPLE `
34+ file which contains sample configuration. Copy this file and name it ` application.properties ` .
35+
36+ Open the new file and set all the required properties as described.
37+
38+ ### Setting up MySQL database with Docker (preferred)
39+ In the project you can find ` docker-compose.yml ` file for the MySQL database Docker container. Edit the environment
40+ variables to match ` application.properties ` and then start the container with ` docker-compose up -d ` .
41+
42+ You can also use your own MySQL database server insted if you prefer do to so.
43+
44+ ### Running the Admin UI app
45+ Launch the application by running: ` java -jar arma3-server-gui.jar ` . You should be able to access the GUI through
46+ ` http://localhost:8080 ` by default.
47+
48+ ### Setting up SteamAuth
49+ In the GUI, navigate to "App config" tab. Here you need to enter your Steam account username, password and
50+ the token which you previously received through e-mail. This is needed to interact with SteamCMD to
51+ install/update the server and any workshop mods.
52+
53+ ### Installing Arma 3 server
54+ #### Automatically (preferred)
55+ After setting up the SteamAuth, navigate to "Dashboard" tab and just click the "Update" button. The server should
56+ automatically start installing into the directory specified in the config. Once the server is installed, you
57+ can continue to use the GUI.
58+
59+ #### Manually
60+ You can follow [ this guide] ( https://community.bistudio.com/wiki/Arma_3_Dedicated_Server ) . Install the server to the
61+ directory specified with ` serverDir ` property in ` application.properties `
3562
3663## Planned features
37- - Server logs access
38- - Managing bikeys
39- - Integrated search in Steam Workshop
40- - Download & update scenarios from Steam Workshop
41- - _ Headless client support_
64+ - Docker image for the Admin UI
65+ - Better error messages
66+ - Multiple server instances
67+ - Arma Reforger support (Arma 4 hopefully soon?)
68+ - In-built headless client support
69+ - Workshop scenario installation
70+ - Access to logs
4271
4372## Credits
4473This app is heavily based on Dahlgren's [ Arma Server Admin] ( https://github.com/Dahlgren/arma-server-web-admin ) project
0 commit comments