You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+30-29Lines changed: 30 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,20 +13,18 @@ SWBF2Admin requires the following software to be installed on the host machine:
13
13
14
14
If you are planning on hosting a GoG/Steam server you will also need a GOG Galaxy account owning SWBF2.
15
15
16
-
```diff
17
-
- Using the Steam client for hosting is currently not supported.
18
-
```
16
+
> Using the Steam client for hosting is currently not supported.
19
17
20
18
### Minimal setup
21
19
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.
22
20
23
-
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".
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`.
24
22
25
-
**Should you ever forget your credentials, run reset_webcredentials.bat.
26
-
This will delete all web admin accounts and prompt you for new default credentials.**
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.
27
25
28
26
##### Optional: using the original server package
29
-
If you want to run the old dedicated server, open core.xml,set
27
+
If you want to run the old dedicated server, open `./cfg/core.xml`, set
30
28
```xml
31
29
<ServerType>Gamespy</ServerType>
32
30
```
@@ -44,7 +42,7 @@ If you have any active firewall, the webadmin port (8080 TCP in this case) has t
44
42
45
43
##### Optional: enabling runtime managament
46
44
If you want to use features like ingame commands, announce broadcast, statistics ..., runtime management has be enabled.
47
-
To enable runtime management, open core.xml, set
45
+
To enable runtime management, open `./cfg/core.xml`, set
48
46
```xml
49
47
<EnableRuntime>true</EnableRuntime>
50
48
```
@@ -66,22 +64,22 @@ Depending on which platform you want to use, EITHER follow the "GoG / Steam" OR
2) Using GOG Galaxy, download Star Wars Battlefront II
69
-
3) In GOG Galaxy, open Battlefront II in your library. Click on "More" -> "Manage installation" -> "Show folder"
70
-
4) A Explorer Window will open, open "GameData" and copy all contents to the "server" folder in SWBF2Admin's installation directory
67
+
3) In GOG Galaxy, open Battlefront II in your library. Click on `More -> Manage installation -> Show folder`
68
+
4) A Explorer Window will open, open `GameData` and copy all contents to the `./server` folder in SWBF2Admin's installation directory
71
69
72
70
Do not uninstall the original game or GOG Galaxy after copying the data.
73
71
74
72
##### Gamespy / "Swbfspy"
75
73
1) Install the original dedicated server package
76
-
2) Copy the contents of it's installation folder (the one containing BattlefrontII.exe) to the "server" folder in SWBF2Admin's installation directory
74
+
2) Copy the contents of it's installation folder (the one containing `BattlefrontII.exe`) to the `server` folder in SWBF2Admin's installation directory
77
75
78
76
### First launch
79
-
1) Start SWBF2Admin.exe
77
+
1) Start `SWBF2Admin.exe`
80
78
2) Using your web browser, open the web panel. By default, the web panel is accessible at http://localhost:8080/
81
-
3) Go to "Server Settings" -> "General", adjust server settings to your liking. Make sure that a network adapter is selected under "bind address"
82
-
4) Go to "Server Settings" -> "Map rotation". Add maps using drag&drop.
83
-
5) Go to "Dashboard", click on "Server status" -> "Start"
84
-
6) If you chose to enable runtime management, join your server in game and enter "!gimmeadmin" in chat
79
+
3) Go to `Server Settings -> General`, adjust server settings to your liking. Make sure that a network adapter is selected under `bind address`
80
+
4) Go to `Server Settings -> Map rotation`. Add maps using drag&drop.
81
+
5) Go to `Dashboard`, click on `Server status -> "Start`
82
+
6) If you chose to enable runtime management, join your server in game and enter `!gimmeadmin` in chat
85
83
86
84
## Advanced
87
85
@@ -163,23 +161,23 @@ Notes:
163
161
- The delete option won't appear for your own account
164
162
165
163
## Statistics tracking
166
-
To enable statistics tracking, open game.xml, set
164
+
To enable statistics tracking, open `./cfg/game.xml`, set
- Set Enable to true to enable automatic announce scheduling
180
-
- Adjust Interval to configure the delay between broadcasts
176
+
Open `./cfg/announce.xml`
177
+
- Set `Enable` to true to enable automatic announce scheduling
178
+
- Adjust `Interval` to configure the delay between broadcasts
181
179
182
-
You can now add as many announces as you like to the "AnnounceList" attribute.
180
+
You can now add as many announces as you like to the `<AnnounceList>` attribute.
183
181
Announces must have the following format:
184
182
185
183
```xml
@@ -190,6 +188,7 @@ Announces must have the following format:
190
188
191
189
If EnableParser is set to true, the Announce is parsed before broadcasting it.
192
190
The following tags are replaced:
191
+
193
192
|Tag|Description|
194
193
|------|------|
195
194
|{s:map}|current map|
@@ -213,8 +212,8 @@ The following tags are replaced:
213
212
214
213
##### Using the {t:(format)} tag
215
214
216
-
The {t:(format)} tag can be used to display the current time. Replace (format) with a format string.
217
-
The given formatter has to be a .NET-style format string. (see https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings for reference)
215
+
The `{t:(format)}` tag can be used to display the current time. Replace `(format)` with a format string.
216
+
The given formatter has to be a .NET-style format string. (see <https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings> for reference)
218
217
219
218
Example for a broadcast displaying the current time in HH:mm:ss format:
220
219
```xml
@@ -227,13 +226,13 @@ Conditional broadcasts can be used to trigger custom messages if a special event
227
226
228
227
SWBF2Admin lets you specify unlimited messages for one event. When the event is triggered, one line is chosen from the message pool at random.
229
228
230
-
(see players.xml -> ConditionalMessages for setup syntax)
229
+
(see `./cfg/players.xml -> ConditionalMessages` for setup syntax)
231
230
232
231
## Ingame commands
233
232
234
233
### Getting permissions
235
234
236
-
After you freshly installed SWBF2Admin, join your server and enter !gimmeadmin in chat. This will add your player account to the Administrator group.
235
+
After you freshly installed SWBF2Admin, join your server and enter `!gimmeadmin` in chat. This will add your player account to the Administrator group.
237
236
238
237
By default SWBF2Admin has three user groups configured:
239
238
- Player
@@ -256,11 +255,11 @@ This behaviour can be disabled by setting
256
255
```xml
257
256
<CheckLevel>false</CheckLevel>
258
257
```
259
-
in ./cfg/cmd/putgroup.xml and ./cfg/cmd/rmgroup.xml.
258
+
in `./cfg/cmd/putgroup.xml` and `./cfg/cmd/rmgroup.xml.`
260
259
261
260
### Basic administrative commands
262
261
SWBF2Admin supports all basic administrative commands.
263
-
All commands that expect a player name to be given feature automatic player name detection. This means that you only have to enter parts of a player's name. If the expression provided is ambiguous, the -n \<number\> argument can be used. This will kick the n-th matching player from the score board list.
262
+
All commands that expect a player name to be given feature automatic player name detection. This means that you only have to enter parts of a player's name. If the expression provided is ambiguous, the `-n <number>` argument can be used. This will kick the n-th matching player from the score board list.
264
263
265
264
|Command syntax|Description|
266
265
|--------------|-----------|
@@ -355,18 +354,20 @@ end
355
354
```
356
355
357
356
The init function is called once when SWBF2Admin has finished parsing your script.
357
+
```
358
358
run() is called everytime your command is invoked.
359
359
player: (Player) player who invoked your command
360
360
command: (string) your command alias
361
361
params: (table(of string)) paramaters given by the player
362
+
```
362
363
363
364
### Invoking ingame lua
364
365
SWBF2Admin's command system allows to run lua code in in-game context. This allows to invoke all game-specific lua functions externally without having to munge files.
365
366
Simply use
366
367
```lua
367
368
api.IngameLua("<lua code here>")
368
369
```
369
-
in your custom command script. (Example command: !boom, see ./cfg/dyncmd/boom.lua)
370
+
in your custom command script. (Example command: `!boom`, see `./cfg/dyncmd/boom.lua`)
370
371
For additional information on how to write ingame lua scripts consult the mod tools documentation or <https://github.com/marth8880/SWBF2-Lua-API>.
0 commit comments