Update documentation

Author: github-actions[bot]

docs/README.md

@@ -12,13 +12,15 @@ title: README
 You've found a comprehensive solution that helps you administrate your DCS World servers. It has a Discord integration 
 ([now optional](#dcsserverbot-installation-non-discord)!) with slash-commands, built in per-server and per-user 
 statistics, optional cloud-based statistics, [Coalitions](./COALITIONS.md)-support, a whole 
-[Tournament-System](./plugins/tournament/README.md) and much more!<br> 
+[Tournament-System](./plugins/tournament/README.md), a third-party [web-frontend](https://github.com/Penfold-88/DCS-Statistics-Dashboard) for
+statistics and much more!
+<p> 
 With its plugin system and reporting framework, DCSServerBot can be enhanced very easily to support whatever might come 
 into your mind. DCSServerBot is a solution for DCS server admins built by a DCS server admin.
-
+<p>
 This documentation shows you the main features, how to install and configure the bot and some more sophisticated 
 stuff at the bottom, if you for instance run multiple servers maybe even over multiple locations. 
-
+<p>
 Now let's see what DCSServerBot can do for you (installation-instructions [below](#installation))!
 
 ---
@@ -345,7 +347,7 @@ NODENAME:                       # this will usually be your hostname
   listen_address: 0.0.0.0       # Optional: On which interface should the bot listen? Default is 127.0.0.1.
   public_ip: 88.77.66.55        # Optional: Your public IP. ONLY if you have a static IP (!), put this in here to speedup the startup-process of the bot.
   slow_system: false            # Optional: if you are using a slower PC to run your servers, you should set this to true (default: false)
-  use_upnp: true                # The bot will auto-detect, if there is an UPnP IGD available and configure this setting initially for you! If you do NOT want to use UPnP, even IF it is abailable, put this to false.
+  use_upnp: true                # The bot will auto-detect, if there is an UPnP IGD available and configure this setting initially for you! If you do NOT want to use UPnP, even IF it is available, put this to false.
   preferred_master: true        # cluster only: this node should be the preferred master node (default: false)
   heartbeat: 30                 # cluster only: time for the heartbeat between the master and agent nodes to run (default: 30)
   cloud_drive: false            # cluster only: set this to false, if you do not have the bot installed on a cloud drive (default and recommended: true) 
@@ -370,6 +372,17 @@ NODENAME:                       # this will usually be your hostname
     cloud: true                 # If you have installed DCS on a NAS or cloud drive, autoupdate and desanitization will only take place once on all your nodes.
     desanitize: true            # Desanitize your MissionScripting.lua after each update. Default is true.
     minimized: true             # Start DCS minimized (default: true)
+    allow_unsafe_api:           # as of DCS 2.9.18: allow dostring_in only in these environments
+      - scripting
+      - gui
+      - userhooks
+    allow_dostring_in:          # as of DCS 2.9.18: allow dostring_in only targeting these contexts
+      - scripting
+      - config
+      - server
+      - mission
+      - gui
+      - export
     user: xxxx                  # Your DCS username (only needed for specific use-cases)
     password: xxxx              # Your DCS password (will be auto-moved by the bot to a secret place)
   instances:

docs/extensions/lardoon/README.md

@@ -16,8 +16,9 @@ MyNode:
   # [...]
   extensions:
     Lardoon:
+      use_single_process: true      # Start one Lardoon process per node (default: true) 
       cmd: '%USERPROFILE%\Documents\GitHub\lardoon\lardoon.exe'
-      bind: 0.0.0.0:3113            # IP and port the Lardoon server is listening to
+      bind: 0.0.0.0:3113            # IP and port the (single) Lardoon server is listening to
       url: https://myfancyhost.com  # Alternate hostname to be displayed in your status embed 
       minutes: 5                    # Number of minutes the Lardoon database is updated
   # [...]
@@ -27,9 +28,16 @@ MyNode:
       extensions:
         Lardoon:
           enabled: true
-          debug: true               # Show the Lardoon console output in the DCSSB console. Default = false
+          debug: true                   # Show the Lardoon console output in the DCSSB console. Default = false
+          bind: 0.0.0.0:3113            # Optional: IP and port this Lardoon server is listening to (only needed if use_single_process is false)
+          url: https://myfancyhost.com  # Optional: Alternate hostname to be displayed in your status embed (only needed if use_single_process is false)
+          minutes: 5                    # Optional: Number of minutes the Lardoon database is updated (only needed if use_single_process is false)
           tacviewExportPath: 'G:\My Drive\Tacview Files'  # Alternative drive for tacview files (default: auto-detect from Tacview)
 ```
-Don't forget to add some kind of security before exposing services like that to the outside world, with for instance
-a nginx reverse proxy.</br>
+Remember to add some kind of security before exposing services like that to the outside world, with for instance
+an nginx reverse proxy.</br>
 If you plan to build Lardoon on your own, I'd recommend the fork of [Team LimaKilo](https://github.com/team-limakilo/lardoon).
+
+> [!IMPORTANT]
+> If you want to start multiple Lardoon processes, set use_single_process to false and make sure that you add a "bind"
+> parameter to each instance configuration.

docs/extensions/olympus/README.md

@@ -17,6 +17,8 @@ DCS_MERCS:
   - name: DCSOlympus
     version: latest
     source: SavedGames
+    # uncomment for auto-update:
+    # repo: https://github.com/Pax1601/DCSOlympus
 ```
 To use the DCS Olympus client, you need [Node.js](https://nodejs.org/download/release/latest-v20.x/) installed.
 Click on the link, download and install it. Remember the installation location, as you need to provide it in the 

docs/extensions/srs/README.md

@@ -38,12 +38,14 @@ MyNode:
           config: '{instance.home}\Config\SRS.cfg'
           host: 127.0.0.1
           port: 5002
-          minimized: true     # start SRS minimized (default: true)
+          gui_server: true    # Optional: use the SRS-Server.exe (GUI server) instead of the command line one
+          minimized: true     # Old SR-Server.exe: start SRS minimized (default: true)
           autoconnect: true   # install the appropriate DCS-SRS-AutoConnectGameGUI.lua, default: true
           awacs: true         # if you use LotAtc
           lotatc_export_port: 10712
           blue_password: blue
           red_password: red
+          show_passwords: false   # Optional: do not show red/blue passwords in the status embed (default: true)
           radio_effect_override: false                # optional: disable radio effects (LOS, etc)
           global_lobby_frequencies: 248.22,30.0,127.0 # optional: set your music channels in here
           autostart: true     # optional: if you manage your SRS servers outside of DCSSB, set that to false

docs/plugins/README.md

@@ -278,7 +278,7 @@ function myplugin.onPlayerConnect(id)
     dcsbot.sendBotTable(msg)
 end
 
-DCS.setUserCallbacks(myplugin)
+Sim.setUserCallbacks(myplugin)
 ```
 
 ### lua/commands.lua
@@ -292,7 +292,7 @@ local dcsbot = base.dcsbot
 
 function dcsbot.pauseMission(json)
     log.write('DCSServerBot', log.DEBUG, 'Mission: pauseMission()') 
-    DCS.setPause(true)
+    Sim.setPause(true)
 end
 ```
 

docs/plugins/cloud/README.md

@@ -22,7 +22,7 @@ used to see with `/statistics`.
 If you opt in to the cloud plugin and even have not opted in to the cloud statistics, you can still use the global ban
 system. We've put together a group consisting of the admins of the most popular DCS servers, and we monitor what's going
 on in the community. When we see someone that is crashing servers by hacking or any other **really** (really) bad stuff,
-we put them in the global ban list. Nobody that gets usually banned on a server for misbehaviour will get onto the list.
+we put them in the global ban list. Nobody that gets usually banned on a server for misbehavior will get onto the list.
 There are only the real bad guys on it.</br>
 If you opt in to that plugin, you already participate from that ban list. You can choose whether to ban DCS players 
 and/or Discord users. Both are active as a default.</br>
@@ -31,6 +31,7 @@ If you are a server admin of a large server and not part of DGSA, the "DCS Globa
 ## Configuration
 ```yaml
 DEFAULT:
+  banlist: pvp                          # One of pvp, pve or both. For DCS bans / watchlist only (default: both).
   dcs-ban: true                         # true: subscribe to the global ban service for DCS users (default: false).
   discord-ban: true                     # true: subscribe to the global ban service for Discord users (default: false).
   watchlist_only: true                  # true: a player being on the global banlist will be added to the watchlist only (default: false, does not work with dcs-ban: true)

docs/plugins/creditsystem/README.md

@@ -14,10 +14,11 @@ away due to punishment points a player gets due to team-kills or the like.
 ## Configuration
 The CreditSystem is configured with a file named config\plugins\creditsystem.yaml. You'll find a sample file in that directory:
 ```yaml
-DEFAULT:              # valid for all servers
-  initial_points: 10  # The initial points a player gets (default = 0).
-  max_points: 100     # The maximum points a player can get (default = unlimited).
-  multiplier: 1       # multiplier for credit points on proper landings (if payback is enabled in slotblocking.yaml)
+DEFAULT:                # valid for all servers
+  initial_points: 10    # The initial points a player gets (default = 0).
+  max_points: 100       # The maximum points a player can get (default = unlimited).
+  multiplier: 1.0       # multiplier for credit points on proper landings if payback is enabled in slotblocking.yaml (default: 1.0)
+  points_on_rtb: false  # only give credit points on RTB (default: false)
   squadron_credits: true # enable squadron credits (see below).
   squadron:
     initial_points: 100 # default: 0

docs/plugins/mission/README.md

@@ -73,10 +73,25 @@ DEFAULT:
 You can configure the behaviour of the mission plugin with an optional config/plugins/mission.yaml:
 ```yaml
 DEFAULT:
-  uploads:              # Configure how mission uploads are handled
-    enabled: true       # Here you can disable the feature at all (default: true = enabled)
+  event_filter:       # do NOT report these events (default: [])
+    - connect
+    - disconnect
+    - change_slot
+    - friendly_fire
+    - self_kill
+    - kill
+    - takeoff
+    - landing
+    - crash
+    - eject
+    - pilot_death
+    - shot
+    - hit
+  uploads:                      # Configure how mission uploads are handled
+    enabled: true               # Here you can disable the feature at all (default: true = enabled)
+    channel: 112233445566778899 # Optional: mission upload channel (default: admin channel)
     discord:
-      - DCS Admin       # Define which roles are allowed to upload missions (default: DCS Admin)
+      - DCS Admin               # Define which roles are allowed to upload missions (default: DCS Admin)
 ```
 
 ## Auto-Scanning

docs/plugins/motd/README.md

@@ -67,7 +67,7 @@ If you want to play sounds, make sure that you loaded them into the mission firs
       display_type: chat      # the message will be displayed in the in-game chat
     - delay: 120              # this message will be displayed every 2 mins
       message: "To see your stats, you can link your user by using /linkme in your discord!"
-      receipients: '!@everyone' # and will be sent to anybody that is not linked yet (has not the discord role @everyone)
+      recipients: '!@everyone' # and will be sent to anybody that is not linked yet (has not the discord role @everyone)
       display_type: popup     # Message will be a popup
 ```
 

docs/plugins/punishment/README.md

@@ -33,10 +33,13 @@ DEFAULT:
     human: 12
     AI: 8
     reason: Friendly fire on a team member
-  - event: collision_hit    # if you hit another team member, you get 5 points, 1 if it was an AI.
+  - event: collision_hit    # If you hit another team member, you get 5 points, 1 if it was an AI.
     human: 5
     AI: 1
     reason: Colliding with a team member
+  - event: reslot           # If you re-slotted when being shot at, you get 30 points (you stole a kill)
+    default: 30
+    reason: Respawning when being shot at
   forgive: 30               # People can forgive others in-between of 30 seconds (default) with the .forgive in-game chat command.
   punishments:              # list of punishments, based on the users penalty points
   - points: 100             # we temp-ban the player when they reached 100 points.