help

This bot can also be added as a user app, letting you use it outside servers where it’s installed.

Installable as User App

Whether the current project contains any paid features, is paid only, or is 100% free to use.

This project is free to use and contains no paywalls for core functionality.

Has Paid Features

UpvoteEngine is a performant Discord vote handler built on a FaaS architecture using Cloudflare Workers. This serverless approach ensures highly performant role management by automatically assigning and removing roles based on top.gg votes with minimal latency and maximum scalability due to the services used.

## Currently supported platforms

- Top.gg
- DBL (Discord Bot List)

There are more platforms planned, but not added yet (because every platform requires a completely new handler).

---

## How to use the bot

Use the `/app` command to configure your application. This commands requires **Manage Server** perms by default.

Note, that you can have up to 25 applications per server, but can only have one server configured per application + source.

<table>
<thead>
<tr>
<th><strong>Valid Examples</strong></th>
<th><strong>Invalid Examples</strong></th>
</tr>
</thead>
<tbody>
  <tr>
    <td>
<ul>
<li>Top.gg Bot #1 → Server A (allowed)</li>

<li>Top.gg Bot #2 → Server B (allowed)</li>

<li>DBL Bot #1 → Server A (allowed, different source)</li>
</ul>
    </td>
    <td>
<ul>
<li>Top.gg Bot #1 → Server A</li>

<li>Top.gg Bot #1 → Server A (rejected, same app + same server + source already configured)</li>

<li>Top.gg Bot #1 → Server B (rejected, same app + source already configured)</li>
</ul>
    </td>
  </tr>
</tbody>
</table>


In short: The combination of application, server and source must be unique across all servers.


## Commands

| Command | Description |
| ------- | ----------- |
| `/help` | Get helpful links to resources for the bot |
| `/ping` | Responds with a pong |
| `/app add` | Configure a new application connection for the server |
| `/app edit` | Edit an application connection for the server |
| `/app remove` | Remove an application connection the server |
| `/app list` | List all application connections for the server |
| `/app forwarding set` | Set the forwarding configuration for an added application |
| `/app forwarding edit` | Edit a forwarding configuration |
| `/app forwarding remove` | Remove a forwarding configuration |
| `/app forwarding view` | View the forwarding configuration (Secret is sanitized, only the first 4 characters are shown) |

Always read the descriptions everywhere. Please.

### Further Reading

- [Webhook Forwarding](https://github.com/The-LukeZ/upvote-engine/wiki/Webhook-Forwarding): Receive vote notifications at an endpoint of your choice.

<style>
table {
  border-collapse: separate;
  border-spacing: 4px;
}

td, th {
  border: 1px solid #45556c;
  padding: 8px;
}
</style>

UpvoteEngine

Handles votes and applies roles, either temporary or permanently, in your associated discord server. Open Source.

Voting for UpvoteEngine

Do you want to support us?