Support specifying the message format that is used

Fixes: #12

Author: FlorianSW

.env.example

@@ -40,3 +40,15 @@ DISCORD_TOKEN=
 # and update messages in this channel. The status message might not contain all information depending on the player
 # count provider, the game and the used game server.
 DISCORD_MESSAGE_CHANNEL_ID=
+
+
+# Message formats
+# You can define your own message formats for the player count display in the user list in Discord.
+# Following variables are available:
+#  - playerCount: The current player count on the server
+#  - maxPlayers: The maximum number of players that can be on the server
+#  - queuedPlayersMessage: The message as defined in DISCORD_PUBLISHER_MESSAGE_QUEUED_FORMAT (only makes sense when the server supports a player queue
+#  - queuedPlayers: The number of players currently in the queue
+# Example (uncomment if editing):
+# DISCORD_PUBLISHER_MESSAGE_FORMAT=${playerCount}/${maxPlayers} ${queuedPlayersMessage}
+# DISCORD_PUBLISHER_MESSAGE_QUEUED_FORMAT=(+${queuedPlayers})

src/adapter/discord/discord-publisher.spec.ts

@@ -18,7 +18,7 @@ describe('DiscordPublisher', () => {
         });
         client.login(process.env.DISCORD_TOKEN || '');
 
-        publisher = new DiscordPublisher(client, new NoOpMapsRepository());
+        publisher = new DiscordPublisher(client, new NoOpMapsRepository(), {playerCount: '', queuedPlayers: ''});
     });
 
     afterEach(() => {

src/adapter/discord/discord-publisher.ts

@@ -5,11 +5,16 @@ import {ActivityType} from 'discord-api-types/v10';
 import {existsSync, mkdirSync, readFileSync, writeFileSync} from 'fs';
 import {MapsRepository} from '../../domain/maps-repository.js';
 
+export interface MessageFormats {
+    playerCount: string,
+    queuedPlayers: string,
+}
+
 export class DiscordPublisher implements GameStatusPublisher {
     private messageId: string | undefined;
     private channel: TextChannel | undefined;
 
-    constructor(private readonly client: Client, private readonly maps: MapsRepository) {
+    constructor(private readonly client: Client, private readonly maps: MapsRepository, private readonly formats: MessageFormats) {
         if (!process.env.DISCORD_MESSAGE_CHANNEL_ID) {
             return
         }
@@ -65,32 +70,39 @@ export class DiscordPublisher implements GameStatusPublisher {
                 text: 'Developed by FlorianSW',
             });
         if (status === undefined) {
-            await this.client.user?.setPresence({
+            this.client.user?.setPresence({
                 status: 'idle',
                 activities: [{
                     type: ActivityType.Watching,
                     name: 'the server boot',
                 }],
             });
-            await this.client.user?.setStatus('dnd');
+            this.client.user?.setStatus('dnd');
             embed
                 .setColor(Colors.DarkGrey)
                 .setTitle('Server is offline right now, waiting for first status');
         } else {
-            let name = status.playerCount + '/' + status.maxPlayers;
+            let message = this.formats.playerCount
+                .replace('${playerCount}', status.playerCount.toString())
+                .replace('${maxPlayers}', status.maxPlayers.toString());
             if (status.queuedPlayers) {
-                name = `${name} (+${status.queuedPlayers})`;
+                message = message.replace(
+                    '${queuedPlayersMessage}',
+                    this.formats.queuedPlayers.replace('${queuedPlayers}', status.queuedPlayers.toString(10))
+                );
+            } else {
+                message = message.replace('${queuedPlayersMessage}', '');
             }
-            await this.client.user?.setPresence({
+            this.client.user?.setPresence({
                 status: 'online',
                 activities: [{
                     type: ActivityType.Playing,
-                    name: name
+                    name: message
                 }]
             });
             const fields: EmbedField[] = [{
                 name: 'Players',
-                value: name,
+                value: message,
                 inline: false,
             }];
             if (status.map) {

src/index.ts

@@ -21,7 +21,10 @@ class App {
     public async setup() {
         this.client = await this.createDiscordClient();
         try {
-            const publisher = new DiscordPublisher(this.client, new FileBackedMapRepository());
+            const publisher = new DiscordPublisher(this.client, new FileBackedMapRepository(), {
+                playerCount: process.env.DISCORD_PUBLISHER_MESSAGE_FORMAT || '${playerCount}/${status.maxPlayers} $queuedPlayers',
+                queuedPlayers: process.env.DISCORD_PUBLISHER_MESSAGE_FORMAT || '(+${queuedPlayers})',
+            });
             this.useCase = new ProvideGameStatus(providerFactory().build(), publisher);
         } catch (e) {
             this.client?.destroy();