strings.md

In this package, you can customize display strings when certain events happen, like, someone wins a game or makes a wrong guess. To be more specific, in default settings, all strings displayed on Discord are located in strings.json, but you can overwrite them by passing corresponding objects to DjsGameOptions#strings.

For example, if you want to change the string that shows when someone hit the answer in Final Code, you can do:

const game = new DjsFinalCode({
  source: interaction ?? message,
  time: 15e3,
  players: [
    player1, player2, player3
  ],
  strings: { // this will overwrite the default strings settings
    endMessages: {
      win: "Oh no, <player>! You hit the final code <answer>!"
    }
  }
});

You might notice that there are substrings <player> and <answer> in it, and those are called specifiers. Usually, the specifiers represent substrings that vary from game to game, such as the player's name, scores, etc. It's ok to discard some specifiers if you prefer, which will not break the functionality.

If you are planning to make a bot in languages other than English, feel free to copy the content of strings.json, translate them into any language you want, and create your own json file, say, mystrings.json. Then, you can include them in your game as below:

const mystrings = require('./your/path/to/mystrings.json');
const game = new DjsFinalCode({
  source: interaction ?? message,
  time: 15e3,
  players: [
    player1, player2, player3
  ],
  strings: mystrings.finalCode
});

If you are not sure the meaning of any string, you can refer to our documentations for Strings.