Pagination

Pagination is a system which will convert multiple embeds in one and add reactions to swipe threw them.

Replace [prefix] with your server's prefix.

Setup a Embed for Pagination

To setup a pagination embed, we need to create a normal embed via the bot first. We do this by running the command [prefix]createembed [code]

// Syntax
[prefix]createembed [code]

// Example
[prefix]createembed {embed}{description: test embed}

Set Embed as Pagination Embed

After we done this, we need to get the message url or the message id from the created embed. After we did this, we can run the following command, to set the recently created embed as a paginated one.

// Syntax
[prefix]pagination set [message id/message link]

// Example
[prefix]pagination set 1279146812875214929

If the command was successful, we can see two arrow reactions under the embed. Now that we've done that, we can add pages to the embed.

If you do not add any footer to your embeds, the paginator will automatically set the footer to display the current page and highest page (e.g. Page 1 of 4)

Adding Pages to the Embed

To add more Pages to the paginated embed, we need to create a new embed code for our second embed. You can do this by running [prefix]embedsetup and create one via discord, or you can use our online embedbuilder.

When this is done, we can start by running following command: [prefix]pagination add

// Syntax
[prefix]pagination add [message id/message link] [code]

// Example
[prefix]pagination add 1279146812875214929 {embed}{description: test embed no.2}

Delete a Page from the Embed

If you wish to remove a page from your paginated embed. You can do this easily by running [prefix]pagination remove

If you don't know the page number, you can switch between the pages of your paginated embed to see the page in the footer. Otherwise, the pages are listed in the order you've added them to the embed.

// Syntax
[prefix]pagination remove [message id/message link] [page]

// Example
[prefix]pagination update 1279146812875214929 2

Updating a Page in the Embed

You've got a typo in your embed script or want to change a specific page? No problem, you dont need to reset the whole embed to edit it. You only need to get the new embed code for the specific page you wanna change, and then need to run [prefix]pagination update

// Syntax
[prefix]pagination update [message id/message link] [page] [code]

// Example
[prefix]pagination update 1279146812875214929 2 {embed}{description: edited embed no.2}

Restore the Emoji Reactions

If the emoji reactions from the bot gets removed somehow from the embed, then you can add them back by running following command: [prefix]pagination restorereactions

// Syntax
[prefix]pagination restorereactions [message id/message link]

// Example
[prefix]pagination restorereactions 1279146812875214929

Remove a Pagination Embed

To remove a pagination embed completely with pages and everything, you can do this by running the command: [prefix]pagination delete

// Syntax
[prefix]pagination delete [message id/message link]

// Example
[prefix]pagination delete 1279146812875214929

Reset all Pagination Embeds

If you wish to disable the pagination module completely or just want to reset/remove all embeds with just one command, you can run: [prefix]pagination reset