Ducks

Configuring the Duck Game Module

The Duck Game module spawns ducks randomly in channels and allows users to interact with them by befriending, trapping, or shooting them. The module also tracks user statistics related to their interactions with ducks.

Configuration Options

Enable/Disable Ducks

Enable or disable duck spawning in a specific channel.

• Usage:
  • ,config channel:<channel_name> ducks-enabled true|false
• Example:
  • ,config channel:#examplechannel ducks-enabled true

Set Minimum Messages Between Ducks

Set the minimum number of messages between duck spawns.

• Usage:
  • ,config channel:<channel_name> ducks-min-messages <number>
• Example:
  • ,config channel:#examplechannel ducks-min-messages 100

Enable/Disable Kicking for Non-existent Ducks

Enable or disable kicking users who talk to non-existent ducks.

• Usage:
  • ,config channel:<channel_name> ducks-kick true|false
• Example:
  • ,config channel:#examplechannel ducks-kick true

Enable/Disable Prevent Highlight

Enable or disable preventing user highlights with !friends / !enemies.

• Usage:
  • ,config channel:<channel_name> ducks-prevent-highlight true|false
• Example:
  • ,config channel:#examplechannel ducks-prevent-highlight true

Set Fine Percentage for Shooting Ducks

Set the fine percentage for users who shoot a duck.

• Usage:
  • ,config channel:<channel_name> ducks-fine-percentage <percentage>
• Example:
  • ,config channel:#examplechannel ducks-fine-percentage 10

Commands and Usage

Manually Trigger a Duck

Manually triggers a duck to appear (requires permission).

• Usage:
  • ,duckappear

Show Total Coins

Shows the total amount of coins in the bot.

• Usage:
  • ,totalcoins

Befriend a Duck

Befriends a duck in the channel.

• Usage:
  • ,befriend or ,bef

Trap a Duck

Traps a duck in the channel.

• Usage:
  • ,trap

Shoot a Duck

Shoots a duck in the channel.

• Usage:
  • ,bang

Show Top 10 Duck Friends

Shows the top 10 users who have befriended the most ducks.

• Usage:
  • ,friends [channel]

Show Top 10 Duck Enemies

Shows the top 10 users who have shot the most ducks.

• Usage:
  • ,enemies [channel]

Show Duck Statistics

Shows duck-related statistics for a user.

• Usage:
  • ,duckstats [nickname]

Examples

• To enable duck spawning in a channel:

  • ,config channel:#examplechannel ducks-enabled true

• To set the minimum messages between ducks to 100:

  • ,config channel:#examplechannel ducks-min-messages 100

• To befriend a duck:

  • ,befriend

• To shoot a duck:

  • ,bang

• To show the top 10 duck friends in a channel:

  • ,friends #examplechannel

• To show duck statistics for a user:

  • ,duckstats username