Updated some samples.

DB connection missed max_retries in the schema

Author: karel26

README.md

@@ -417,7 +417,6 @@ NODENAME:                       # this will usually be your hostname
           host: 127.0.0.1       # SRS servers local IP (default is 127.0.0.1)
           port: 5002            # SRS servers local port (default is 5002). The bot will change this in your SRS configuration if set here!
           autostart: true       # this will autostart your DCS server with the DCS server start (default: true)
-          autoupdate: true      # This will auto-update your SRS servers. Default is false, you need to run the bot as Administrator to make it work!
         Tacview:
           show_passwords: false # If you don't want to show the Tacview passwords (default: true)
 #    instance2:                 # you can have an unlimited number of instance configurations, but each instance has to have a physical representation on your disk.
@@ -437,10 +436,10 @@ DEFAULT:
   messages:                     # General messages for servers. You can overwrite any in any server.
     greeting_message_members: "{player.name}, welcome back to {server.name}!"
     greeting_message_unmatched: '{player.name}, please use /linkme in our Discord, if you want to see your user stats!'
-    message_player_username: Your player name contains invalid characters. # Default message for players with invalid usernames
-      Please change your name to join our server.
-    message_player_default_username: Please change your default player name at the top right  # Default message for players with default usernames
-      of the multiplayer selection list to an individual one!
+    message_player_username: Your player name contains invalid characters. 
+      Please change your name to join our server. # Default message for players with invalid usernames
+    message_player_default_username: Please change your default player name at the top right  
+      of the multiplayer selection list to an individual one! # Default message for players with default usernames
     message_player_inappropriate_username: Your username is inappropriate and needs to be changed to join this server.
     message_ban: 'You are banned from this server. Reason: {}' # default message, if a player is banned on the DCS server
     message_reserved: 'This server is locked for specific users.\nPlease contact a server admin.' # Message if server requires discord role (optional)

plugins/srs/README.md

@@ -16,10 +16,10 @@ If you want to use the slot blocking feature, you need to create a config/plugin
 ```yaml
 DEFAULT:
   message_no_srs: You need to use SRS to play on this server!
-  enforce_srs: true   # block slots until SRS is activated
-  move_to_spec: true  # move people back to spectators, if they leave SRS (only if enforce is true) 
+  enforce_srs: true   # Block slots until SRS is activated. People can not use slots, if not on SRS!
+  move_to_spec: true  # Move people back to spectators if they leave SRS (only if enforce is true) 
 ```
-You can define, which server (instance) will use this blocking feature by specifying the instance name instead of 
+You can define which server (instance) will use this blocking feature by specifying the instance name instead of 
 DEFAULT.
 
 ## Discord Commands

samples/main.yaml

@@ -1,8 +1,9 @@
 guild_id: 112233445566  # Your Discord server ID. Right-click on your server and select "Copy Server ID".
-use_dashboard: true     # Use the dashboard display for your node. Default is true.
+use_dashboard: false     # Use the dashboard display for your node. Default is true.
 chat_command_prefix: .  # The command prefix to be used for in-game chat commands. Default is "."
 database:
-  url: postgres://USER:PASSWORD@DB-IP:DB-PORT/DB-NAME
+  url:
+    postgres://dcsserverbot:SECRET@localhost:5432/dcsserverbot?sslmode=prefer # The bot will auto-move the database password from here to a secret place and replace it with SECRET.
   pool_min: 5           # min size of the DB pool, default is 5
   pool_max: 10          # max size of the DB pool, default is 10
 logging:
@@ -13,15 +14,15 @@ filter:
   server_name: ^Special K -           # Filter to shorten your server names on many bot displays. Default is none.
   mission_name: ^Operation|_|\(.*\)   # Filter to shorten your mission names on many bot displays. Default is none.
   tag: "'^[JDS]'"                     # If your community uses specific tags, this helps with the bots automatch functionality.
-opt_plugins:                          # Optional: list of optional plugins to be loaded and used by the bot
-- serverstats                         # see above
-- dbexporter
-- motd
-- greenieboard
-- punishment
-- slotblocking
-- music
-- funkman
-- modmanager
-- commands
-- restapi
+opt_plugins: # Optional: list of optional plugins to be loaded and used by the bot
+  - serverstats                         # see above
+  - dbexporter
+  - motd
+  - greenieboard
+  - punishment
+  - slotblocking
+  - music
+  - funkman
+  - modmanager
+  - commands
+  - restapi

samples/nodes.yaml

@@ -1,4 +1,4 @@
-NODENAME:                       # this will usually be your hostname
+Legion: # this will usually be your hostname
   listen_port: 10042            # On which port should the bot listen? Default is 10042
   listen_address: 127.0.0.1     # Optional: On which interface should the bot listen? Default is 127.0.0.1 (localhost only).
   # public_ip: 88.77.66.55        # Optional: Your public IP. ONLY if you have a static IP! Put this in here to speed up the startup-process of the bot.
@@ -7,8 +7,9 @@ NODENAME:                       # this will usually be your hostname
   nodestats: true               # Enable/disable node statistics (database pool and event queue sizes), default: true
   # restrict_commands: true       # Disable commands that can affect the integrity of the server. Default: false (see MULTINODE.md)
   # restrict_owner: false         # If set to true, the owner of the bot can also not run restricted commands. Default: false (see MULTINODE.md)
-  database:                     # Optional: It might be that you need to use different IPs to connect to the same database server. This is the place you could do that.
-    url: postgres://USER:PASSWORD@DB-IP:DB-PORT/DB-NAME   # The bot will auto-move the database password from here to a secret place and replace it with SECRET.
+  database: # Optional: It might be that you need to use different IPs to connect to the same database server. This is the place you could do that.
+    url:
+      postgres://dcsserverbot:SECRET@localhost:5432/dcsserverbot?sslmode=prefer # The bot will auto-move the database password from here to a secret place and replace it with SECRET.
     pool_min: 5                 # min size of the DB pool, default is 5
     pool_max: 10                # max size of the DB pool, default is 10
     max_reties: 10              # maximum number of retries to initially connect to the database on startups
@@ -18,17 +19,17 @@ NODENAME:                       # this will usually be your hostname
   #   heartbeat: 30               # Cluster only: time for the heartbeat between the master and agent nodes to run (default: 30)
   #   cloud_drive: true           # Cluster only: set this to false if you do not have the bot installed on a cloud drive (default and recommended: true)
   DCS:
-    installation: '%ProgramFiles%\\Eagle Dynamics\\DCS World Server'  # This is your DCS installation. Usually autodetected by the bot.
+    installation: '%ProgramFiles%\\Eagle Dynamics\\DCS World'  # This is your DCS installation. Usually autodetected by the bot.
     autoupdate: true            # enable auto-update for your DCS servers. Default is false.
-    announce:                   # Optional: post a message to Discord after an update was conducted
+    announce: # Optional: post a message to Discord after an update was conducted
       channel: 11223344556677
       title: DCS has been updated to version {}!
       description: 'The following servers have been updated:'
       footer: Please make sure you update your DCS client to join!
-      mention:                  # Optional mentioning
+      mention: # Optional mentioning
         - Admin
         - DCS Admin
-    update_window:              # Optional update window. No update will happen if N is set for the respective time and day.
+    update_window: # Optional update window. No update will happen if N is set for the respective time and day.
       timezone: Europe/Berlin   # Optional timezone, default is the local time of the server.
       00-18: YYYYYYY
       18-20: YYYYYYN            # Do not update DCS on Sundays, 18:00-20:00 LT
@@ -39,18 +40,18 @@ NODENAME:                       # this will usually be your hostname
     minimized: true             # Start DCS minimized (default: true)
     # 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)
-  extensions:                   # Your extensions have 2 sections, one in the node and one in each instance.
-    SRS:                        # Your node-global settings for SRS
+  extensions: # Your extensions have 2 sections, one in the node and one in each instance.
+    SRS: # Your node-global settings for SRS
       installation: '%ProgramFiles%\DCS-SimpleRadio-Standalone'
-      autoupdate: true          # Auto-update SRS, whenever a new version is available.
+      autoupdate: true          # Auto-update SRS whenever a new version is available.
       use_upnp: true            # Do you want to use UPnP to auto-forward your SRS ports? If not set, the global setting will be used.
-    Tacview:                    # Your node-global settings for Tacview
-      installation: 'C:\Program Files (x86)\Steam\steamapps\common\Tacview'
+    Tacview: # Your node-global settings for Tacview
+      installation: C:\Program Files (x86)\Steam\steamapps\common\Tacview
       tacviewExportPath: '%USERPROFILE%\Documents\Tacview'
-#   Any other Extension:
-#     ...
+  #   Any other Extension:
+  #     ...
   instances:
-    DCS.dcs_serverrelease:        # The name of your instance. You can have multiple instances that have to have unique names.
+    DCS.dcs_serverrelease: # The name of your instance. You can have multiple instances that have to have unique names.
       home: '%USERPROFILE%\\Saved Games\\DCS.dcs_serverrelease' # The path to your saved games directory.
       missions_dir: '%USERPROFILE%\Documents\Missions'       # You can overwrite the default missions dir like so. Default is the Missions dir below the instance home folder.
       mission_rewrite: false    # Disable rewrite of missions by MizEdit or RealWeather. The server will be stopped for any mission change then. (default: true)
@@ -60,14 +61,14 @@ NODENAME:                       # this will usually be your hostname
       max_hung_minutes: 3       # Let DCSServerBot kill your server if it is unresponsive for more than x minutes. Default is 3. Disable it with 0.
       # affinity: 2,3             # Optional: set the CPU-affinity for the DCS_Server.exe.
       priority: normal          # Optional: set the process priority (low, normal, high, realtime) for the DCS_Server.exe
-      extensions:               # See the extension documentation for more detailed information on what to set here.
+      extensions: # See the extension documentation for more detailed information on what to set here.
         SRS:
           config: '%USERPROFILE%\Saved Games\DCS.dcs_serverrelease\Config\SRS.cfg'  # it is recommended to copy your SRS "server.cfg" below your instances home directory.
           host: 127.0.0.1       # SRS servers local IP (default is 127.0.0.1)
           port: 5002            # SRS servers local port (default is 5002). The bot will change this in your SRS configuration if set here!
           autostart: true       # this will autostart your DCS server with the DCS server start (default: true)
-          autoupdate: true      # This will auto-update your SRS servers. Default is false, you need to run the bot as Administrator to make it work!
         Tacview:
           show_passwords: false # If you don't want to show the Tacview passwords (default: true)
-#    instance2:                 # you can have an unlimited number of instance configurations, but each instance has to have a physical representation on your disk.
-#      ...
+  #    instance2:                 # you can have an unlimited number of instance configurations, but each instance has to have a physical representation on your disk.
+  #      ...
+  use_upnp: false

samples/plugins/creditsystem.yaml

@@ -8,45 +8,45 @@
 # instance the SlotBlocking-plugin, that can block slots by  #
 # credits.                                                   #
 ##############################################################
-DEFAULT:              # valid for all servers
+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)
   squadron_credits: true # enable squadron credits (see below).
-  points_per_kill:    # How many points do players get when they kill another unit?
-  - default: 1        # You get at least one point (default = 0).
-  - category: Ships   # If you kill a ship. you get 2 points
-    points: 2
-  - category: Air Defence
-    points: 3
-  - category: Planes
-    type: AI          # for planes and helicopters you can decide whether you killed an AI or a human player
-    points: 3
-  - category: Planes
-    type: Player
-    points: 4
-  - category: Planes
-    type: Player
-    unit_type: F-14B  # you can specify the unit_type, unit_name, group_name as another differentiation
-    points: 5
-  - category: Helicopters
-    points: 3
-  achievements:       # OPTIONAL: you can give players Discord roles according to their achievements
-  - credits: 0
-    playtime: 0       # Playtime is in hours
-    role: Rookie      # Initially, with 0 credits and 0 playtime, you get the role "Rookie" (has to be in Discord)
-  - credits: 50
-    playtime: 25
-    role: Veteran     # to get the Veteran role, you have to have EITHER 50 credit points OR a playtime of 25 hrs
-  - credits: 100
-    playtime: 50
-    combined: true    # you need to have 100 credit points AND a playtime of more than 50 hrs to get the "Ace" role
-    role: Ace
-  leaderboard:        # Simple leaderboard, persistent, displayed in a channel of your choice
+  points_per_kill: # How many points do players get when they kill another unit?
+    - default: 1        # You get at least one point (default = 0).
+    - category: Ships   # If you kill a ship. you get 2 points
+      points: 2
+    - category: Air Defence
+      points: 3
+    - category: Planes
+      type: AI          # for planes and helicopters you can decide whether you killed an AI or a human player
+      points: 3
+    - category: Planes
+      type: Player
+      points: 4
+    - category: Planes
+      type: Player
+      unit_type: F-14B  # you can specify the unit_type, unit_name, group_name as another differentiation
+      points: 5
+    - category: Helicopters
+      points: 3
+  achievements: # OPTIONAL: you can give players Discord roles according to their achievements
+    - credits: 0
+      playtime: 0       # Playtime is in hours
+      role: Rookie      # Initially, with 0 credits and 0 playtime, you get the role "Rookie" (has to be in Discord)
+    - credits: 50
+      playtime: 25
+      role: Veteran     # to get the Veteran role, you have to have EITHER 50 credit points OR a playtime of 25 hrs
+    - credits: 100
+      playtime: 50
+      combined: true    # you need to have 100 credit points AND a playtime of more than 50 hrs to get the "Ace" role
+      role: Ace
+  leaderboard: # Simple leaderboard, persistent, displayed in a channel of your choice
     channel: 112233445566778899
     limit: 10         # max number of entries to be shown
-DCS.server:           # valid for a specific server
-  initial_points:     # different initial points can be specified for different Discord roles
-  - discord: Donator
-    points: 15
-  - default: 10
+DCS.dcs_serverrelease: # valid for a specific server
+  initial_points: # different initial points can be specified for different Discord roles
+    - discord: Donator
+      points: 15
+    - default: 10

samples/plugins/mission.yaml

@@ -3,6 +3,3 @@ DEFAULT:
     enabled: true   # Here you can disable the feature at all (default: true = enabled)
     discord:
       - DCS Admin   # Define which roles are allowed to upload missions (default: DCS Admin)
-  afk_exemptions:   # List of UCIDs that are exempted from AFK kicks (besides the users that have the DCS Admin or GameMaster role)
-    ucid:
-      - aabbccddeeff1122334455

samples/plugins/srs.yaml

@@ -1,4 +1,4 @@
 DEFAULT:
   message_no_srs: You need to use SRS to play on this server!
-  enforce_srs: true   # block slots until SRS is activated
-  move_to_spec: true  # move people back to spectators, if they leave SRS (only if enforce is true)
+  enforce_srs: true   # Block slots until SRS is activated. People can not use slots, if not on SRS!
+  move_to_spec: true  # Move people back to spectators if they leave SRS (only if enforce is true)