Getting Started

After buying a subscription, you'll receive an invite link for discord and slack to add the Workout Bot to the supported platforms. You'll also receive an activation code. By clicking the link, the bot will join your server and then you just have to type !activate YOUR_ACTIVATION_CODE to activate it.

Everything is then set-up. Any group member can now use the bot and, the first time they do so, an invidiual account will be created for them without any additional interaction.

The individual user account can be used to check your individual progress and can be linked on other servers or platforms using the bot, meaning you can track your progress accross different servers and groups of friends.

Note that there's a limit to the number of different members that can use the bot in the server, which is set depending on your subscription plan (the cheapest plan allows for up to 25 users).

Track your exercise

The core functionality of the bot is tracking exercise through the chat room. To add an exercise send a message with the format +AMOUNT EXERCISE to register the exercise with the given amount. For example, one might write +25 pushups to register 25 pushups or, similarly, +35 squats to add 35 squats.

By default simple exercises such as pushups, abs, squats and km running are available. Attempts to register an exercise which doesn’t exist will fail, but your server can make new exercises available (see below).

You can, optionally, add the unit and a comment to each exercise submission — you can note down, e.g., the time you took, the number of repetitions, or more information: +5.3 km running (in 35 minutes), or +1200 meters swimming (crawl) .

The full syntax is +AMOUNT [UNIT] EXERCISE [COMMENT].

Creating custom exercises

To ensure no nonsense exercises are created, only the user who activated the bot has the ability to create new exercises. To do so, they have to send a message with the format !new EXERCISE_NAME [unit type] [muscle group], in which both the units and muscle group are optional.

For example, one might create the exercise swimming measured in meters with !new swimming meters, and any user can register it with +1200 meters swimming, or just (because it’s implicitly in meters) +1200 swimming.

Challenges

The user who activated the bot can create group-wide challenges by sending the message !challenge AMOUNT EXERCISE TIME_INTERVAL [COMMENT]. A challenge is a quota that ought to be fulfilled by group members taking the challenge.

This could be, for example, the goal of doing 100 pushups every day. One could create said challenge with !challenge 100 pushups daily.

Dashboards

It would be pretty pointless to track your exercise if you couldn't see the data afterwards. In a group chat with an activated bot, you can ask for a link to the group dashboard with !dashboard group.

In the group's dashboard you have multiple data graphs showing progress and activity overtime, exercise heatmaps, progress on challenges, leaderboards featuring the group members, and cummulative amounts of exercises for the whole group.

In your user dashboard, which you get to by sending the message !dashboard, features similar data visualizations as the group dashboard, but only containing your individual exercises.

Both dashboards are read-only and can be shared to outsiders not using the bot by simply sharing the link (which is only valid for a limited time, in case you change your mind). The group dashboard's link is sent to the group chat on request, while your individual dashboard is sent privately to your private messages.

Linking your user account on a new server

Imagine the following scenario: you have started using the bot with your friends in a discord server, where you log some push-ups everyday. However, today your team at work have set it up on your slack server and you want to join in on the fun but keep it in sync with what you do on the other server too.

You want to add 50 push-ups through discord and have them show up on your work server’s dashboard too. This is done by **linking**.

On your discord server type !getLinkingCode and copy the code sent directly to you by the bot. On your slack server type !link YOUR_LINKING_CODE.

Now, both exercises added through the discord server and through the slack server will be added to your individual account. The numbers shown on the group’s leaderboard will be those too.

FAQ

Something missing? Do let me know on the issue tracker or through my e-mail, rodrigo.m.mesquita()gmail.com.