The "Ban Sync" feature in Cakey Bot offers server owners an efficient and synchronized method to manage bans across multiple servers within a designated pool. This feature significantly streamlines moderation efforts and maintains consistency in enforcing bans across interconnected communities.
Server Pool Creation: Server owners initiate the ban synchronization process by creating a designated pool of servers through the web dashboard.
Ban Replication: When a user receives a ban within a server in the established pool, the bot identifies and replicates this ban, swiftly implementing the same action across all other connected servers.
Quick Updates: The Ban Sync feature processes bans via a queue which prevents the bot from being restricted by ratelimits. However, bans are also checked when a user joins the server allowing almost real-time enforcement by banning users instantly who have not been processed by the queue yet.
Multi-Way Syncing: Within a designated pool, bans are synchronized across all servers, irrespective of the server where the ban was initially issued. This means bans will sync across all servers within the pool even if the ban did not originate in the server that created the pool.
Note: If a server is in multiple pools, it is possible for the ban to propogate across multiple pools.
If you don't want a specific ban to be automatically synced, you may include the
-nosyncflag in the ban reason and it will be ignored by the ban sync feature. Note, however, that unbans will ALWAYS be synced since you are unable to provide a reason.
Currently servers are limited to creating 1 pool per server. However, servers can be included in any number of pools.
To create a new pool simply login to the web dashboard and follow these steps:
You have now created you first ban sync pool. Read the section below to add servers to your newly created pool.
By default servers are NOT allowed to be added to pools. In order to allow the server to be added to a pool, you will need to click the "Enable Ban Sync for this server" button on the Ban Sync page.
You will need to enable ban sync for every server you wish to add to a ban sync pool.
Note: Once the server has been added to a pool you can disable this toggle again to prevent the server from being added to other pools. This toggle will NOT remove servers from existing pools, it only prevents the server from being added to new pools.
The number of servers allowed in a given pool at once is tiered: 3 for free servers, 7 for Premium servers, and 15 for Custom Bot (whitelabel) servers. However, a server can be included in multiple different pools.
While on the Ban Sync page follow these steps:
By default, servers will NOT be able to be added to Ban Sync pools. You will have the manually toggle this to be "Enabled" on each server you wish to add.
Cakey Bot has 3 types of direction. These can be set independantly for both bans and unbans depending on your needs. The 3 types include:
Note: Since these can be mix & matched, you should take note of how they will interact with each other. For example, if server A is set to "Two-Way" but server B is set to "Only Receive" then any bans in server B will NOT send to server A even though server A is set to Two-Way.
Only the server that created the pool can remove servers from the pool. Servers that have been added to the pool can choose to "leave" the pool however.
While on the Ban Sync page follow these steps:
Servers that create a pool will only be able to delete the pool, they can not leave the pool.
Servers that have been added to a pool will be able to see that they have been added to the pool. In addition to this, they will be able to leave the pool. Servers that are added to pools will not be able to edit other servers in the pool or delete them. Only the server that created the pool will be able to manage it. To leave a pool simply click the orange "Leave" button at the bottom of the pool.