Documentation

Overview

WordleBot is a new Discord bot that automatically tracks results from your daily games and compiles them into an easy-to-read format. If you and your friends like to compete at Wordle, Quordle, Connections, and more, then WordleBot can make your competition a lot easier for players and admins alike.

Install/Signup

Use the following link to install WordleBot on your server. You must have "manage server" permissions on the server in order to install it. If you own or administer the server, it is likely that you have this permission. Clicking on the link will open Discord and prompt you to select a server on which to install WordleBot. You may also copy and paste the link into the chat on the server where you wish to install:

Upon successful install, you should see WordleBot added as a user in your server.

WordleBot successfully installed

Once WordleBot is installed and has joined the server, "signup" can happen. There is no form to fill out, and no personal information is needed.

Your server is registered as soon as anyone pastes a result in the Discord server. By default, the first channel where a valid result is pasted will be set as the "home" channel, which may be changed later. Only this home channel will be monitored for results. See sethome for more detail.

Each user is registered and associated with a server as soon as they do either of the following in a server where WordleBot is installed:

• Paste a valid result
• Use the command addme

A user may be associated with more than one server. See crossposting for details.

Pasting Results

WordleBot will, by default, accept the default copy-paste from the mobile versions of each supported game. Many of these pastes, however include information that is not important for statkeeping and may include links that Discord will turn into a link preview. In the interest of saving space and avoiding clutter in the chat, shortened versions of most pastes will be accepted, and these are detailed in this section. For each game, an example of the default copied text is given. Required text is highlighted in green, while non-required text is highlighted in red:

In general, if you leave the pasted text alone, WordleBot will accept it, and it will not force you to add or remove any text, especially from the middle of the paste.

Crossposting

If you happen to belong to multiple servers where WordleBot is installed, you may post your results to all of them with a single post to any of them - WordleBot will post on your behalf everywhere else! You must associate yourself with each server by either posting a valid result or running addme for this to work - see install/signup for details. If you leave a server, WordleBot will no longer post there on your behalf.

WordleBot crossposts on your behalf to your other servers

Leaderboards

WordleBot creates monthly leaderboards for your server in each game that you choose to track. See setgames for details on choosing which games to track. You can access your server leaderboard or your personal stats page by issuing the we or the i commands, respectively. The addresses of these pages do not change, so you may bookmark them for easy access.

Each game comes with a basic set of stats, viewable by default on the leaderboard. Most of the column headers are clickable, which will sort the table by that column. The column headers also come with tooltips, so you may click or mouse-over them to see a short explanation of what they represent.

A section of a leaderboard, sorted by "Avg"

Finally, you may click on any user's avatar or name to go to their personal stats page.

Achievements

WordleBot keeps a list of achievements in each game (and some that span multiple games). WordleBot will react to your post with the medal (🎖️) emoji if you unlock an achievement.

Achievement unlocked!

To view your achievements, go to your personal page (linked with the i command) and select the "Achievements" tab. Locked achievements are grayed out, while unlocked ones are colored in. You may also mouse-over or click any achievement to see a tooltip on the requirements to unlock it.

The Achievements area

Slash Commands

WordleBot comes with a series of slash commands that allow admins and players to interact with it. Generally, WordleBot's responses to commands are ephemeral, meaning only the user issuing the command can see it. This reduces server clutter, and is a security feature, as your server's WordleBot settings are changed through a one-time-use link (see settings for details).

• sethome - This command sets the home channel for the server to the channel in which the command is run. Only results posted to that channel will be acknowledged and saved. The default value for this channel will be wherever the first result is pasted after installing WordleBot.
• setgames - This command returns a menu of games to track on the server. Thus, if your server only plays Wordle and Connections, you can indicate that using this command. Your server standings page will only include results from the games selected. Your home channel will only receive cross-posted results from the games selected. Players may still post their other results in your channel, and they will be acknowledged and cross-posted to other servers if applicable.
• settings - This command will give you flexibility in how your games are ranked. For example, you may indicate that a player must submit at least 20 Wordle results to be eligible to win the month, or that mistakes in Connections should incur a heavier penalty. Your settings page will also give you the ability to create custom stats so that you can play your own way! See settings for more details
• i - This command causes the bot to reply to you with a link to your personal stats page, which is https://www.wordlebot.gg/player/[your user ID]
• we - This command causes the bot to reply to you with a link to your server's stats page, which is https://www.wordlebot.gg/wordle/server/[your guild ID]
• addme - This command associates you with the server in which you issue it. You may be associated with multiple servers. Use this command if you are part of multiple servers with WordleBot, and you can make sure your results are properly tracked and crossposted without having to post results in every single one.
• myservers - This command lists the servers with which you are associated. If you leave a server, WordleBot will not recognize it immediately, but if you post a result elsewhere, WordleBot will check to make sure you are still a member of any server where it might get crossposted before making a crosspost.
• help - This command causes the bot to reply to you with a link to this page.
• faq - This command causes the bot to reply to you with a link to the FAQ page.

Customization

WordleBot provides settings and custom stats so that you can play the game your way!

Settings

Access your settings page by issuing the settings command. This will give you a one-time-use link to your server settings page, usable for 5 minutes. If you close your settings page and need to edit the settings again, or if you wait too long and the link expires, you may issue the settings command again to get a new link.

The link to the settings page

From the linked page, you may edit the settings for each game. For an explanation of each setting, you may mouse-over or click the icon next to the setting.

In general, each game has a "fill in scores" setting, to tell WordleBot what to do about stats if a player does not submit results for a day. Select each option in the "Fill in scores" setting box to see what each one does. Some games also include a setting for scoring penalties if a player loses a game. In general, these are meant to encourage players to play and post results every day, even if they lose or get a bad score.

Fill-in scores settings

A few examples of fill-in policies:

• None - unplayed days do not count towards any stats
• Loss - unplayed days count as a loss
• Server average - unplayed days are given a score of the server average (usually rounded to the player's detriment)
• Server worst - unplayed days are given a score equal to the worst on the server that day
• Server worst+ (or Server worst -) - unplayed days are given a score equal to the worst on the server that day, with a small penalty

Public servers

WordleBot allows you to set your server to be discoverable by fellow daily game players. An admin needs to open your server settings (see settings) and set the server to public. Your server must have a description and an invite link (recommended to be set to never expire with unlimited uses). Furthermore, your server description and name cannot have any vulgar language.

Setting your server to public

When you set your server to public, it can be found at https://www.wordlebot.gg/servers, and anyone can join it.

List of public servers with join buttons

To revoke an invite link, should it become necessary, follow the steps below. This cannot be undone and you must generate a new invite link and save it to your server settings to allow people to join again.

Desktop Mobile

1. Right-click on your server's icon in your Discord app, and go to Server Settings > Invites

   

2. Mouse-over the invite link and click the red X at the top-right corner. The link will be revoked.

   

1. Select your server's icon in the Discord app, and go to the server settings

   

2. Select the "Settings" icon

   

3. Scroll to the "User Management" section (near the bottom) and select "Invites"

   

4. Find the invite link that you wish to revoke, and select the "..." icon on it.

   

5. Select "Revoke" and the link will be revoked.

   

Custom Stats

WordleBot offers admins a way to create custom stats to include on their leaderboards. As stats have different attributes for different games, custom stats are created for each game individually. Thus, if you have a similar stat that you'd like to see for all three Quordle variants, you will have to recreate it for each game.

To start creating a custom stat, open the settings page and click the header for the game for which you want to make a custom stat, and click "New".

Creating a custom stat

The custom stat window

A custom stat consists of two parts: an optional set of filters that subset the data, and a calculation/aggregation to perform on the remaining data.

Custom Stat Settings

Custom stats have a series of settings that you can set so that they appear as you wish.

Custom stat settings

• Name - an arbitrary name. Must be unique to the game (e.g. you may not create two stats called "Average").
• Heading - the column heading to show on the leaderboard. Maximum length of 10 characters.
• Description - a description of the stat. This will show up on the tooltip for the column header on the leaderboard.
• Include fill-in scores - whether to include filled-in scores in this stat. If checked, unplayed days will count towards this stat. You must also have a fill-in policy other than "None" for this game in order for this to matter.
• Set as default sort - whether to sort by this column by default. You may only have one default sort column per game, and if you save a custom stat with this option checked, then that stat will no longer be the default sort.
• Default sort direction - the direction to sort by default.
• Decimal places - the number of decimal places to round to
• Format - whether to format the number as a number or a percent. If formatted as a percent, you do not need to multiply the result by 100 - WordleBot will automatically convert 0.5 to 50%.

Filters

You may have any number of filters (including none at all) on the data for each custom calculation. Filters allow you to, for example, create a stat that drops the worst 2 scores of the month, or keep the best 20, or only count the number of times a player gets a 2 on Wordle. Filters are applied before any calculations are performed.

To create a filter, click the "new" button under the "Filters" section of the custom stats window.

Create a new filter

The create filter window will open and you can create your filter.

The create filter window

The following settings are available to create filters.

• Name - an arbitrary value for your own reference, but it must be unique within each custom stat

• Filter type - there are two types of filters.

  • Rank filter (or a "keep/drop" filter) - filter the data by keeping or dropping a number of scores from either end of the data. For example, this filter can keep the best 20 scores of the month, or drop the worst 2 scores. If there is a "keep" filter applied to the data, any player who does not have enough plays to meet the requisite number of data points will have an asterisk next to this stat in the leaderboard and will appear at the bottom of any sort by this stat.
  • Data filter - filter the data based on an attribute of the data itself. For example, this filter can keep only the scores that are less than 6, or equal to 2.

After clicking "Save", the filter should appear in the list of filters for this stat.

A created filter

You may edit a filter by clicking the pencil icon on its tile, or delete it by clicking the trash can icon.

Calculations

The calculations interface may have a bit of a learning curve, but with a little practice it's pretty easy to use.

The custom calculation window

Your custom calculation not contain any unaggregated data items, or else it will not save. For example, placing just the "Score" data item in the calculation area and nothing else will not allow you to save the calculation.

You must aggregate all data items in your calculation.

A simple valid calculation

This quick demo will walk you through a more complex calculation - the standard deviation of the score - to demonstrate the functionality of the calculation interface. Generally, on more complex calculations, we will need to work "out to in", meaning we start with the outermost operations and work our way in.

The formula for the standard deviation of score is below:

Standard deviation formula

We need to take the difference between each score and the average score, square those, and sum the resulting set. Then, divide by the count minus 1, and take the square root of that result. The steps are as follows:

1. In the calculation interface, start by creating a square root. Note that the square root appears in the "preview" area, and the element inside the square root is now selected by default. Whatever we select next will appear in place of that element.

   

2. Create the fraction by selecting the "a/b" button

   

3. We will now create the "count - 1" in the denominator. Click the element in the denominator of the fraction to set it active. A thin blue border should appear around it.

   

4. Click the "a-b" button to create a subtraction

   

5. Click the "count" aggregation button.

   

6. Verify that the element inside the "count" aggregation is active. Select "Score" under "Data Items/Constants" and click "Add"

   

7. Click the second element in the subtraction in the denominator to set it active

   

8. Select "(Constant)" under "Data Items/Constants", type in "1" in the value box next to the drop down, and click "Add". The second element in the subtraction should be replaced with a 1.

   

9. We will now work with the numerator. Click the empty element in the numerator to set it active.

   

10. Click the "Sum" aggregation. An empty sum should appear in the numerator.

    

11. Inside the sum, select the a^b operator.

    

12. Click the exponent to set it active, and set its value to a constant 2, similarly as in step 8.

    

13. Click the base to set it active.

    

14. Click on "a-b" to place a difference there.

    

15. Click the first element of the difference to set it active. Select the "Score" data item again and click "Add".

    

16. Click the second element of the difference to set it active. Click the "Avg" aggregation.

    

17. Inside the AVG aggregation, select the "Score" data item again and click "Add".

    

18. If we've done everything right, the "save" button should be enabled. Save the calculation. The edit calculation window should close, the formula should appear in the preview area in the "custom stat" window, and after specifying the other settings, we should be able to save our custom stat!

    

19. The new stat should appear as a tile under the custom stats area of the game. Press the pencil icon to edit it, or the trash can icon to delete it. If you have multiple custom stats, you can use the arrow icons to change the order in which they appear on your leaderboard.

    

20. You must click either of the save buttons at the top or bottom of the settings page to save your custom stat, or any other settings you have changed.

    

Privacy

No personal information (e-mail, address, phone, etc.) will ever be collected. The data I have is limited to what is available on Discord - your server's name, ID, banner (if applicable), and icon, and your users' username, display name, ID, and profile picture, all of which is publicly available on your discord pages. Only necessary data (e.g. scores, times, etc.) will be saved from pasted game results. The text of the paste and any extra text will not be saved. No data will ever be sold or given to any other party.

Additional help

If you need additional help or support, you can join the WordleBot Discord server here and talk to me: