descriptionslop

server/src/services/discordBotService/configuration.js

@@ -15,22 +15,34 @@ module.exports = {
     roles: { stalkerPing: '', announcementPing: '', adminPing: '', humanAlertPing: '' },
   },
   schema: strictObject({
-    enabled: boolean(),
-    token: string({ title: 'Bot token', writeOnly: true, maxLength: 10000 }),
-    guildId: string({ title: 'Guild id', maxLength: 100 }),
-    siteUrl: string({ title: 'Public site URL', maxLength: 2048 }),
+    enabled: boolean({ description: 'Logs the Discord bot in and enables commands, chat bridges, replay delivery, and configured announcements after restart.' }),
+    token: string({ title: 'Bot token', description: 'Discord bot token used to log in. The saved value is never returned to the browser.', writeOnly: true, maxLength: 10000 }),
+    guildId: string({ title: 'Guild id', description: 'Reserved Discord server identifier. The current bot runtime does not restrict commands or events using this value.', maxLength: 100 }),
+    siteUrl: string({ title: 'Public site URL', description: 'Public base URL appended to announcement embeds and server-hosted replay links.', maxLength: 2048 }),
     channels: strictObject({
-      general: string({ maxLength: 100 }),
-      announcements: string({ maxLength: 100 }),
-      adminAlerts: string({ maxLength: 100 }),
-      replay: string({ maxLength: 100 }),
-      humanAlerts: string({ maxLength: 100 }),
-    }, { required: ['general', 'announcements', 'adminAlerts', 'replay', 'humanAlerts'] }),
+      general: string({ description: 'Channel ID used by the button-box stalker-role and everyone-ping rewards.', maxLength: 100 }),
+      announcements: string({ description: 'Channel ID used for public-mode openings, objective changes, and all-rovers-unlocked announcements.', maxLength: 100 }),
+      adminAlerts: string({ description: 'Channel ID used for rover health, battery, dock, help, and daily fleet-report notifications.', maxLength: 100 }),
+      replay: string({ description: 'Channel ID used to upload generated replay videos when Discord replay delivery is available.', maxLength: 100 }),
+      humanAlerts: string({ description: 'Channel ID used for physical human-alert button notifications and captured images.', maxLength: 100 }),
+    }, {
+      title: 'Channels',
+      description: 'Discord channel IDs that route each category of bot output.',
+      required: ['general', 'announcements', 'adminAlerts', 'replay', 'humanAlerts'],
+    }),
     roles: strictObject({
-      stalkerPing: string({ maxLength: 100 }),
-      announcementPing: string({ maxLength: 100 }),
-      adminPing: string({ maxLength: 100 }),
-      humanAlertPing: string({ maxLength: 100 }),
-    }, { required: ['stalkerPing', 'announcementPing', 'adminPing', 'humanAlertPing'] }),
-  }, { title: 'Discord', required: ['enabled', 'token', 'guildId', 'siteUrl', 'channels', 'roles'] }),
+      stalkerPing: string({ description: 'Role ID mentioned by the button-box stalker-ping reward in the general channel.', maxLength: 100 }),
+      announcementPing: string({ description: 'Role ID mentioned by configured user announcements.', maxLength: 100 }),
+      adminPing: string({ description: 'Role ID mentioned for important administrative rover, battery, and help alerts.', maxLength: 100 }),
+      humanAlertPing: string({ description: 'Role ID mentioned when the physical human-alert button is pressed.', maxLength: 100 }),
+    }, {
+      title: 'Roles',
+      description: 'Discord role IDs mentioned for specific notification categories.',
+      required: ['stalkerPing', 'announcementPing', 'adminPing', 'humanAlertPing'],
+    }),
+  }, {
+    title: 'Discord',
+    description: 'Optional Discord bot credentials, public URL, and notification routing.',
+    required: ['enabled', 'token', 'guildId', 'siteUrl', 'channels', 'roles'],
+  }),
 };