Skip to content

Commit 6ea5ed8

Browse files
committed
update README.md
1 parent 3734f31 commit 6ea5ed8

File tree

1 file changed

+40
-25
lines changed

1 file changed

+40
-25
lines changed

README.md

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,44 @@
11
# Arma 3 Server GUI
2+
A simple administration web app for managing your Arma 3 server
23

3-
## Status to MVP
4-
- [x] Steam Workshop integration for mods
5-
- [x] Mod download, update, installation, removal
6-
- [x] Copy bikeys into server folder
7-
- [x] Listing all installed mods
8-
- [x] Cronjob updating mods every day
9-
- [x] Server configuration & launching
10-
- [x] Start, stop, restart server
11-
- [x] Select mods
12-
- [x] Status monitoring
13-
- [x] Basic server config editor
14-
- [x] Uploading custom scenarios from local machine
15-
- [x] React web interface
16-
- [x] Server config editor
17-
- [x] Server status dashboard
18-
- [x] Mod installation by giving steam ID / list of steam ids
19-
- [x] App config menu (for steam credentials, ...)
20-
21-
## Future roadmap
4+
[Screenshots](https://imgur.com/a/jEkDCkc)
5+
6+
##Features
7+
- Start, stop, update your server while keeping track of its current state
8+
- Configure the server without the need for modifying your server.cfg
9+
- Download and manage Steam Workshop mods
10+
- Upload custom scenarios from your local machine
11+
12+
##Installation
13+
Before attempting to install this GUI, make sure you've successfully installed SteamCMD and Arma 3 dedicated server.
14+
You can follow [this guide](https://community.bistudio.com/wiki/Arma_3_Dedicated_Server).
15+
16+
After you have your SteamCMD and Arma 3 dedicated server working, either download the GUI jar file or build it from the
17+
source using `gradle assemble`.
18+
19+
In the same path, create a new directory `config` and put `application.properties.EXAMPLE` inside. Now, delete
20+
the extension .EXAMPLE, leaving you with `application.properties`. In this file, configure all the necessary properties.
21+
22+
Launch the application: `java -jar arma3-server-gui.jar`. Your GUI should now be available to access from the browser
23+
on the set port, `8080` by default.
24+
25+
## Steam Workshop
26+
For downloading workshop mods and keeping the server up-to-date, you're going to need a Steam account with
27+
a copy of Arma 3, otherwise, these features will not be available.
28+
29+
It's not necessary to have a separate account for downloading the mods and gaming. However, you might encounter some
30+
issues such as being disconnected from your Steam account when it's needed for mod download and updating.
31+
32+
If your account is protected by Steam Guard 2FA, you can optionally put in the verification token. This token should
33+
be delivered to your account's email after the first attempt of updating the server and/or downloading a mod.
34+
35+
##Planned features
2236
- Server logs access
23-
- Download & update scenarios from Steam Wokshop
37+
- Managing bikeys
2438
- Integrated search in Steam Workshop
25-
- Basic workshop search
26-
- Uploading mods from local machine
27-
- Headless client support
28-
- _Multiple servers support?_
29-
- _Config storage in Google Cloud?_
39+
- Download & update scenarios from Steam Workshop
40+
- _Headless client support_
41+
42+
## Credits
43+
This app is heavily based on Dahlgren's [Arma Server Admin](https://github.com/Dahlgren/arma-server-web-admin) project
44+
and I took a lot of inspiration from it on how to make things work, especially when working with the Steam Workshop.

0 commit comments

Comments
 (0)