Skip to content

Commit bc76ebf

Browse files
committed
Disable ups
Fix readme.md format
1 parent e1f8e1f commit bc76ebf

File tree

3 files changed

+34
-33
lines changed

3 files changed

+34
-33
lines changed

DebugFiles/cfg/dyncmd/boom/boom.lua

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ end
55
function run(player, command, params)
66
-- spawn 25 time bombs around 0,0
77
local s =
8-
"for i=-5,5 do\n" ..
9-
"for j=-5,5 do\n" ..
10-
"local m = CreateMatrix(0,0,0,0,j*10,5,i*10)\n" ..
8+
"for i=0,5 do\n" ..
9+
"for j=0,5 do\n" ..
10+
"local m = CreateMatrix(0,0,0,0,j*10,15,i*10)\n" ..
1111
"CreateEntity(\"cis_weap_inf_timebomb_ord\", m)\n" ..
1212
"end\n" ..
1313
"end"

RconServer/config.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@
1010
* CAUTION: can cause uncontrolled UDP output, only for testing purposes
1111
* crashes clients to desktop
1212
*/
13-
#define EXPERIMENTAL_UPS
13+
//#define EXPERIMENTAL_UPS

readme.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,18 @@ SWBF2Admin requires the following software to be installed on the host machine:
1313

1414
If you are planning on hosting a GoG/Steam server you will also need a GOG Galaxy account owning SWBF2.
1515

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.
1917
2018
### Minimal setup
2119
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.
2220

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`.
2422

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.
2725
2826
##### 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
3028
```xml
3129
<ServerType>Gamespy</ServerType>
3230
```
@@ -44,7 +42,7 @@ If you have any active firewall, the webadmin port (8080 TCP in this case) has t
4442

4543
##### Optional: enabling runtime managament
4644
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
4846
```xml
4947
<EnableRuntime>true</EnableRuntime>
5048
```
@@ -66,22 +64,22 @@ Depending on which platform you want to use, EITHER follow the "GoG / Steam" OR
6664
```
6765
1) Install GOG Galaxy (<https://www.gog.com/galaxy>)
6866
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
7169

7270
Do not uninstall the original game or GOG Galaxy after copying the data.
7371

7472
##### Gamespy / "Swbfspy"
7573
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
7775

7876
### First launch
79-
1) Start SWBF2Admin.exe
77+
1) Start `SWBF2Admin.exe`
8078
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
8583

8684
## Advanced
8785

@@ -163,23 +161,23 @@ Notes:
163161
- The delete option won't appear for your own account
164162

165163
## Statistics tracking
166-
To enable statistics tracking, open game.xml, set
164+
To enable statistics tracking, open `./cfg/game.xml`, set
167165
```
168166
<EnableGameStatsLogging>true</EnableGameStatsLogging>
169167
```
170-
if you want to track player statistics as well, open players.xml, set
168+
if you want to track player statistics as well, open `./cfg/players.xml`, set
171169
```
172170
<EnablePlayerStatsLogging>false</EnablePlayerStatsLogging>
173171
```
174172

175173
## Automatic announce broadcasts
176174

177175
### Configuring the announce scheduler
178-
Open ./cfg/announce.xml
179-
- 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
181179

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.
183181
Announces must have the following format:
184182

185183
```xml
@@ -190,6 +188,7 @@ Announces must have the following format:
190188

191189
If EnableParser is set to true, the Announce is parsed before broadcasting it.
192190
The following tags are replaced:
191+
193192
|Tag|Description|
194193
|------|------|
195194
|{s:map}|current map|
@@ -213,8 +212,8 @@ The following tags are replaced:
213212

214213
##### Using the {t:(format)} tag
215214

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)
218217

219218
Example for a broadcast displaying the current time in HH:mm:ss format:
220219
```xml
@@ -227,13 +226,13 @@ Conditional broadcasts can be used to trigger custom messages if a special event
227226

228227
SWBF2Admin lets you specify unlimited messages for one event. When the event is triggered, one line is chosen from the message pool at random.
229228

230-
(see players.xml -> ConditionalMessages for setup syntax)
229+
(see `./cfg/players.xml -> ConditionalMessages` for setup syntax)
231230

232231
## Ingame commands
233232

234233
### Getting permissions
235234

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.
237236

238237
By default SWBF2Admin has three user groups configured:
239238
- Player
@@ -256,11 +255,11 @@ This behaviour can be disabled by setting
256255
```xml
257256
<CheckLevel>false</CheckLevel>
258257
```
259-
in ./cfg/cmd/putgroup.xml and ./cfg/cmd/rmgroup.xml.
258+
in `./cfg/cmd/putgroup.xml` and `./cfg/cmd/rmgroup.xml.`
260259

261260
### Basic administrative commands
262261
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.
264263

265264
|Command syntax|Description|
266265
|--------------|-----------|
@@ -355,18 +354,20 @@ end
355354
```
356355

357356
The init function is called once when SWBF2Admin has finished parsing your script.
357+
```
358358
run() is called everytime your command is invoked.
359359
player: (Player) player who invoked your command
360360
command: (string) your command alias
361361
params: (table(of string)) paramaters given by the player
362+
```
362363

363364
### Invoking ingame lua
364365
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.
365366
Simply use
366367
```lua
367368
api.IngameLua("<lua code here>")
368369
```
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`)
370371
For additional information on how to write ingame lua scripts consult the mod tools documentation or <https://github.com/marth8880/SWBF2-Lua-API>.
371372

372373
### LUA API documentation

0 commit comments

Comments
 (0)