Word Scramble

Akabot Documentation: Word Scramble

Word Scramble allows you to bring fun into your server with randomly scrambled English words. This module is available in both the non-message intent and message intent versions of the Discord bot.

The message intent version can use the words said in your chats to generate scrambled words. None of this data is ever persisted anywhere.

Configuration

Add a channel to Word Scramble

To configure Word Scramble in a channel, go to a channel and run

/word_scramble set_channel <channel> <chance> <min_chars> <max_chars>

• channel: The channel to set the settings for.
• chance: A number which determines the chance of the word scramble happening. Higher value means less occurrence.
• min_chars: A minimum amount of letters.
• max_chars: A maximum amount of letters.
• context: (message intent version only) Allows you to choose between an English dictionary and either channel messages or guild messages (messages from all channels).

Remove a channel from Word Scramble

To remove a channel from word scramble:

/word_scramble remove_channel <channel>

• channel: The channel to affect.

Set XP per Word Scramble game

To set XP rewards for all Word Scramble games in the current server, run this command:

/word_scramble set_xp_per_game <xp>

• xp: (optional) New value for XP per game. It will show existing value if not present.

Setting a ping role

If you want people to subscribe to word scramble games, you can set a ping role. To do this, run the following command:

/word_scramble set_role <role> <unset>

• role: (optional) Set the role. It will return existing role if not present.
• unset: (optional) Unsets the current value.

Actions

Force Starting a game

To start a game forcibly, run this command:

/word_scramble start

It will start a word scramble game in the current chat. Note this requires the channel settings to be set and a game to NOT be running.

Force Stopping a game

To stop a game forcibly, run this command:

/word_scramble end

It will stop a word scramble game in the current chat. Note this requires the channel settings to be set and a game to be running.