Wise Old Man Discord Bot

https://github.com/wise-old-man/wiseoldman-discord-bot
Admin
A Discord bot that tracks Old School Runescape clan progress, built as an extension of the Wise Old...
Tokens:1,834
Snippets:29
Trust Score:6.3
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Check Discord Bot Configurations

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/how-to-setup.md

Describes how to view the current bot configurations for the server by using the `/help` command without selecting a specific category.

```APIDOC
/help
```

--------------------------------

### Discord Bot: Get Help for a Specific Category

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command allows users to retrieve specific information by selecting a category. The example shows how to get help related to the 'Flag' category.

```Discord Command
/help category: Flag
```

--------------------------------

### Discord Bot: Get General Help Information

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command provides useful links, current configurations, tracked group, and notification settings. It's the default behavior when no specific category is provided.

```Discord Command
/help
```

--------------------------------

### Configure Discord Bot Group

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/how-to-setup.md

Explains how to set the default group for the Discord server using the `/config group` command. This configured group will be used for all subsequent bot commands and notifications related to the server.

```APIDOC
/config group
```

--------------------------------

### Set Player OSRS Name (RSN)

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/how-to-setup.md

Instructs regular players on how to link their OSRS name to the bot using the `/setrsn` command. This allows them to use player-specific commands without repeatedly specifying their RSN.

```APIDOC
/setrsn
```

--------------------------------

### Configure Discord Bot Notifications

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/how-to-setup.md

Details how to specify channels for different types of group-related notifications (e.g., achievements, new member joins) and how to disable specific notification types using the `/config notifications` command.

```APIDOC
/config notifications
```

--------------------------------

### Get Player Gains Over a Month for Specific User

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

Retrieves a specific player's gains within a specified period (e.g., 'month') using the `/gained` command. This command is paginated, allowing navigation through results. The 'username' parameter is optional.

```APIDOC
/gained period: "month" username: "rro"
```

--------------------------------

### Get Efficiency Stats (TTM, EHP, EHB) for Specific User

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

Provides a player's efficiency statistics, including Time to Max (TTM), Time to 200m All, Efficient Hours Played (EHP), and Efficient Hours Bosses (EHB), for a specified RuneScape username via the `/ttm` command. The 'username' parameter is optional, defaulting to the linked RSN.

```APIDOC
/ttm username: "Psikoi"
```

--------------------------------

### Get Efficient Hours Bosses (EHB) for Linked User

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

Retrieves Efficient Hours Bosses (EHB) statistics using the `/stats` command. When no username is specified, the command automatically applies to the RuneScape username linked to the Discord user who sent the command.

```APIDOC
/stats variant: "Efficient Hours Bosses"
```

--------------------------------

### Get Recent Achievements for Specific User

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

Displays a player's most recent achievements for a specified RuneScape username using the `/achievements` command. The 'username' parameter is optional, defaulting to the linked RSN if not provided.

```APIDOC
/achievements username: "Psikoi"
```

--------------------------------

### Discord Bot: Disable a Specific Notification Type

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command disables a specific notification type, preventing the bot from sending those notifications. The example shows how to disable 'Competition Status' notifications.

```Discord Command
/config notifications notification_type: Competition Status notification_channel: #general status: Disable
```

--------------------------------

### Get Player Gains Over a Year for Linked User

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

Retrieves a player's gains within a specified period (e.g., 'year') for the linked RuneScape username using the `/gained` command. This command is paginated, allowing navigation through results. The 'username' parameter is optional.

```APIDOC
/gained period: "year"
```

--------------------------------

### Get Activity Scores for Specific User

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

Retrieves a player's activity statistics, such as minigame scores, for a specific RuneScape username using the `/activities` command. This command supports 'scores' and 'ranks' variants. The 'username' parameter is optional, defaulting to the linked RSN.

```APIDOC
/activities variant: "Scores" username: "Zezima"
```

--------------------------------

### Get Activity Ranks for Linked User

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

Retrieves a player's activity ranks, such as minigame ranks, using the `/activities` command. When no username is provided, it defaults to the RuneScape username linked to the Discord user. This command supports 'scores' and 'ranks' variants.

```APIDOC
/activities variant: "Ranks"
```

--------------------------------

### Get Boss Kill Counts for Specific User

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

Uses the `/bosses` command to retrieve kill counts for a specified RuneScape username. This command provides detailed bossing statistics. The 'username' parameter is optional for most commands, defaulting to the linked Discord user's RSN if omitted.

```APIDOC
/bosses variant: "Kill Counts" username: "Zezima"
```

--------------------------------

### Discord Bot Command: List Group Competitions

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command displays a list of all competitions associated with a configured group. It requires the group ID to be set up in the bot's configuration.

```APIDOC
/group competitions
```

--------------------------------

### Discord Bot: View Group Details

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command displays details about the configured group, such as its name, clan chat, and member count. It requires the group ID to be configured first.

```Discord Command
/group details
```

--------------------------------

### Discord Bot: View Group Competitions

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command shows a list of upcoming or recent competitions associated with the configured group. It requires the group ID to be set up.

```Discord Command
/group competitions
```

--------------------------------

### Discord Bot: List Group Members

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command provides a paginated list of all members in the configured group. Users can navigate through the list using interactive buttons.

```Discord Command
/group members
```

--------------------------------

### Discord Bot Command: View Player Skilling Stats

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command provides a player's skilling statistics. It supports 4 different variants: levels, experience, ranks, or EHP. An optional 'username' parameter can be provided; otherwise, it defaults to the username linked to the Discord user who sent the command.

```APIDOC
/stats variant:Levels username:Zezima
```

```APIDOC
/stats variant:Experience
```

--------------------------------

### Discord Bot Command: Group Records Leaderboard

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command shows a leaderboard of group members' records, sorted by their gained experience, kill count, or score in a specific skill, boss, or activity within a given time period. Requires group ID configuration.

```APIDOC
/group records metric:Farming period:Week
```

--------------------------------

### Discord Bot Command: View Specific Group Competition Details

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command shows details for a specific competition within a group. If no ID parameter is provided, it defaults to showing the current ongoing competition, or an upcoming one if none are ongoing. A group ID configuration is required.

```APIDOC
/group competition
```

```APIDOC
/group competition group_id:15832
```

--------------------------------

### Link Discord User to RuneScape Username

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

Links the Discord user's account to a specific RuneScape username using the `/setrsn` command. This eliminates the need to specify the username for subsequent commands, streamlining bot interaction. This command is essential for using other player commands without explicitly providing a username.

```APIDOC
/setrsn username: "Psikoi"
```

--------------------------------

### Discord Bot: Set Default Notification Channel

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command configures the default channel for all notification types. It requires admin permissions and ensures the bot has permissions in the selected channel.

```Discord Command
/config notifications notification_type: Default notification_channel: #general
```

--------------------------------

### Discord Bot Command: Group Gained Leaderboard

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command generates a leaderboard of group members, sorted by their gained experience, kill count, or score in a specified skill, boss, or activity within a given time period. Requires group ID configuration.

```APIDOC
/group gained metric:Strength period:Month
```

--------------------------------

### Discord Bot: Configure Server's Tracked Group ID

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command sets the group ID for the server, enabling group-specific commands and notifications. It requires admin permissions and uses the group ID from the wiseoldman.net page URL.

```Discord Command
/config group group_id: 139
```

--------------------------------

### Discord Bot Command: Group Hiscores Leaderboard

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command displays a leaderboard of group members, sorted by their current experience, kill count, or score in a specific skill, boss, or activity. Requires group ID configuration.

```APIDOC
/group hiscores metric:Zulrah
```

--------------------------------

### Discord Bot: Set Channel for Specific Notification Type

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command allows specifying a dedicated channel for a particular notification type, such as 'Members Roles Changed'. It requires admin permissions.

```Discord Command
/config notifications notification_type: Members Roles Changed notification_channel: #chat
```

--------------------------------

### Discord Bot Command: Update Player Stats

Source: https://github.com/wise-old-man/wiseoldman-discord-bot/blob/master/docs/docs/commands.mdx

This command sends an update request to the Wise Old Man servers, which will then update a player's stats, records, and achievements. An optional 'username' parameter can be provided; otherwise, it defaults to the username linked to the Discord user who sent the command.

```APIDOC
/update
```
Tokens:
Raw