Skip to content

Commit 5822877

Browse files
committed
Update readme
1 parent 25c6c6a commit 5822877

File tree

1 file changed

+27
-30
lines changed

1 file changed

+27
-30
lines changed

readme.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# SWBF2Admin
23
A modern, easy-to-use server manager for Star Wars Battlefront II (2005) dedicated servers
34

@@ -8,64 +9,60 @@ SWBF2Admin is highly configurable - for advanced configuration techniques or mor
89
### Prerequisites
910
SWBF2Admin requires the following software to be installed on the host machine:
1011

11-
- .NET Framework(or equivalent) v4.6.1 or newer (<https://www.microsoft.com/net/download/windows>)
12-
- Visual C++ Redistributable x86 2015: (<https://www.microsoft.com/en-us/download/details.aspx?id=48145>)
13-
14-
If you are planning on hosting a GoG/Steam server you will also need a GOG Galaxy account owning SWBF2.
12+
- .net 8.0 or newer (https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
1513

16-
> Using the Steam client for hosting is currently not supported.
14+
If you are planning on hosting a GoG/Steam server you will need a GOG Galaxy account owning SWBF2. Using the Steam client for hosting the 2017 GoG release is currently not supported.
1715

1816
### Minimal setup
1917
Extract all files to a destination of your choice, run SWBF2Admin.exe. You will be prompted to set webadmin credentials. Enter username and password of your choice. Close SWBF2Admin afterwards.
2018

21-
Navigate to the `./server` folder in SWBF2Admin's installation directory. Right click `RconServer.dll -> Properties`. Check the `Unblock` option in the lower section of the dialog. Do the same for `dlloader.exe`.
19+
Should you ever forget your credentials, run `reset_webcredentials.bat` for resetting all web admin accounts.
2220

23-
> Should you ever forget your credentials, run reset_webcredentials.bat.
24-
> This will delete all web admin accounts and prompt you for new default credentials.
21+
#### Platform Selection
2522

26-
##### Optional: using the original server package
27-
If you want to run the old dedicated server, open `./cfg/core.xml`, set
23+
Open `./cfg/core.xml` and adjust `ServerType` to match your target platform:
2824
```xml
29-
<ServerType>Gamespy</ServerType>
25+
<ServerType>your_platform</ServerType>
3026
```
27+
Available platforms:
28+
- `GoG` for the 2017 `BattlefrontII Classic` release
29+
- `Gamespy` for the original 2005 `Star Wars BattlefrontII` release
3130

32-
##### Optional: allowing remote access to webadmin
33-
By default, the web panel will only be accessible from the local machine. To change this, open core.xml and adjust
31+
#### Configuring Remote Acces
32+
If you want your web admin panel to be accessible from the internet, adjust `WebAdminPrefix` in `core.xml` to match your server's public endpoint.
3433
```xml
3534
<WebAdminPrefix>http://localhost:8080/</WebAdminPrefix>
3635
```
36+
3737
If you do not have a domain pointing to your server, you can also just use the server's IP-Address, for example
3838
```xml
3939
<WebAdminPrefix>http://192.168.1.234:8080/</WebAdminPrefix>
4040
```
41-
If you have any active firewall, the webadmin port (8080 TCP in this case) has to be unblocked.
41+
If you have any active firewall, the web admin port (8080 TCP in this case) has to be unblocked.
4242

4343
If you prefer to use an encrypted connection, you may change the protocol specified in `WebAdminPrefix` from `http://` to `https://`. Note that when using HTTPS, a matching SSL certificate has to be installed into your machine's certificate store.
4444

45-
##### Optional: enabling runtime managament
46-
If you want to use features like ingame commands, announce broadcast, statistics ..., runtime management has be enabled.
45+
#### Optional: enabling runtime managament
46+
47+
48+
If you want to use features like ingame commands or announce broadcasts, runtime management has be enabled.
4749
To enable runtime management, open `./cfg/core.xml`, set
4850
```xml
4951
<EnableRuntime>true</EnableRuntime>
5052
```
51-
```diff
52-
! When using runtime management, the !gimmeadmin command will add the first user to execute
53-
! it to the "Admin" group. Make sure you are the first one! The command is deactivated after one use.
54-
```
55-
```diff
56-
! When using the GOG version, set GamePort & RconPort in Server Settings to the same value.
57-
```
53+
54+
*When using runtime management, the !gimmeadmin command will add the first user to execute it to the "Admin" group. Make sure you are the first one! The command is deactivated after one use.*
55+
56+
*If you are using the 2017 GOG release, set GamePort & RconPort in Server Settings to the same value.*
5857

5958
### Preparing the gameserver
6059

61-
Depending on which platform you want to use, EITHER follow the "GoG / Steam" OR the Gamespy / "Swbfspy" guide.
60+
Follow one of the following guides below that matches your target platform.
6261

63-
##### GoG / Steam
64-
```diff
65-
! Neither the GOG communications server nor GOG Galaxy works over Windows Remote Desktop.
66-
! You can use tools like VNC or Chrome Remote Desktop instead.
67-
! Launching any part of the server over Windows Remote Desktop causes it to not show up in the server listing.
68-
```
62+
#### 2017 GoG Release (BattlefrontII Classic)
63+
*Neither the GOG communications server nor GOG Galaxy works over Windows Remote Desktop. You can use tools like VNC, Chrome Remote Desktop or a physical KVM instead. Launching any part of the server over Windows Remote Desktop causes it to not show up in the server listing.*
64+
65+
After connecting to your server using previously mentioned tools:
6966
1) Install GOG Galaxy (<https://www.gog.com/galaxy>)
7067
2) Using GOG Galaxy, download Star Wars Battlefront II
7168
3) In GOG Galaxy, open Battlefront II in your library. Click on `More -> Manage installation -> Show folder`

0 commit comments

Comments
 (0)