Create Sign Up Templates
Sign up templates define stuff like the sign up roles (emojis) and how often a user can sign up. Basically stuff that is more "game based" (How many players do you need?) and not "event based" (When does the event start?)
Create the Template
To create a custom template, use the /signup_template create
command.
Name
First the bot asks you for a name. This will help you to keep your templates organized. Example: 10 player raid
, 20 player raid
, 5 player dungeon
or PvP Raid
.
Icon
This icon is only for organizing, as well as the name.
Emoji Behavior
In this step you will select how you sign up with the emojis. There are 3 options:
- One emoji for each role/sub role. (Max 20 emojis)
- One emoji for each role. Sub role selection happens after the main role is selected. (Max 20x20 emojis)
- One emoji for each role. Sub role selection happens via number input.
Example
To show the difference between those 3 modes, all 3 use the same basic setup.
🗡️,role,DD
🏹,role,DD,Range
⚔️,role,DD,Melee
🛡️,role,Tank
⛑️,role,Heal
❓,status,Maybe
❌,status,Absent
⛔,remove
- Option 1
- Option 2
- Option 3
Option 1
every emoji will be displayed directly on the event message. This has the benefit that no additional interaction is needed. However, it also has the disadvantage that you can not use the same emoji twice in different sub groups.The above example would create this event: This option limits the emojis to 20 at max because a Discord message can only hold up to 20 emojis.
Option 2
only main emojis are displayed directly on the event message. If the user signs up to an emoji that has sub emojis, an additional message will be posted in the event channel where the user can press the sub emoji.The above example would create this event: If the user signs up with 🗡️, an additional message is posed and the sub emoji can be selected. Since Discord messages can only hold up to 20 emojis, this option limits the emojis to 20x20.
Option 3
only main emojis are displayed directly on the event message. If the user signs up to an emoji that has sub emojis, the user receives a DM where the bot asks for the emoji to sign up to. The above example would create this event: If the user signs up with 🗡️, an additional message is posed and the sub emoji can be selected. Since this option requires a user input instead of adding emojis to the second message, this option can hold up to 20xinfinite
emojis.Display Top Level Emojis At Field Title
You can use yes
or no
here. For differences, see example below.
- Yes (Show Emojis)
- No (Don't Show Emojis)
Add Emojis to Your Template
In this step you will add emojis to the template. Actually, the bot will describe you in details how to do that. There isn't really much more to say.
Instead here is a picture of what value effects which part of the event message:
Emoji Types
There are different emoji types. Each type serves a specific purpose
role
emojis are used for the actual sign ups. This should be your goto type if you don't need anything special.status
emojis are used to show a certain status. They are perfect for fields like "Maybe", "Bench", "Not Attending", etc.. Some differences are:- Status emojis are shown below a line break in the event message
- The user is not added to the attached thread on sign up.
remove
(Remove Signup): This type removes all signups of the current user when selected.late
(Late +5 min): This type adds a+5min
to the user on every press.rlate
(Remove Late Status): This type removes the late status of the user.
Special emojis (remove
, late
and rlate
) do not have fields in the event message itself.
Every emoji can only be used once atm! If you need to have the same emoji twice, you currently need to upload it to Discord twice. This way the emoji has an other emoji ID.
Changing that is on my todo list, but it sadly isn't that easy. :(
Add Sign Up Limits
In this step you can configure all sign up limits. And if I say all, I mean all!
You can:
- Set the total amount of users that can sign up
- Set the total amount of sign ups with the role emoji
- Set the total amount of sign ups with the status emoji
- Set how often a user can be signed up to the same event
- Set the limit of every role field main emoji/category
- Set the limit of every role field sub emoji/category
- Discord
- Homepage
[
and ]
.0 Means no limit is applied for that field.
0 Means no limit is applied for that field.
Hierarchy
Limits follow a strict hierarchy. Limits higher up in the hierarchy overrule lower ones.
The hierarchy is as follows:
- Total sign ups
- Total Role / Status sign ups
- Main field sign ups
- Sub field sign ups
- User sign ups
Example 1:
Given: The template allows 5
sign ups in total, 3
sign ups for role and 3
sign ups for status fields.
Result: If there are already 3
sign ups for role fields, only 2
more can sign up to status fields.
Example 1:
Given: The template allows 10
sign ups to a specific role field (example DD
). The role field has 2 sub fields (example Melee
and Range
). Melee
has a limit of 3
while Range
has no limit.
Result:
- If
Melee
has3
sign ups, no more than7
Range
users can sign up. - If
Range
has9
sign ups, only one moreMelee
user can sign up.
Set the Color of the Event Message
The color you set here will be the stripe on the left side of the event message (black in the picture above). The color needs to be added in hexadecimal. Just google color code in hex
or use this link.
Done!
Thats it. Your template is created and ready to use! You can either use the /event create
command and pass the template with the template
option, or you can set it as default with /default_template set
.
Notes
Discord Message Limits And Custom Emojis
Raid Organizer
is using so called embeds
for event messages. An embed has an overall message length limit of 6000 characters.
However, each field inside that embed has a limit of 1024 characters.
A field
is one column where the user names are displayed. For example DD
would be one, Maybe
would be another one.
With Default Emojis
If we now say that the average username has 10 characters, ~75 users would fit in one field. That usually is enough.
I went with 75 because standard emojis have a length of 1, plus one space for formatting, plus the possibility of showing the sign up number (3) adds a 5 to the name length.
With Custom Emojis
If we now use custom emojis instead of default emojis, things look different. A custom emoji has the length of the emoji name, the emoji id + formatting payload.
- The emoji id is either 18 or 19 digits long.
- Name is custom, so lets say 5.
- Formatting is either 4 or 5, depending on animated or not.
Which brings us to a length of ~28. Only for the emoji!
If we now add the 10 characters for the average user name, we can see that only ~26 users (instead of 70) are able to sign up to one field.
Learning?
If you are managing a huge guild with a lot of sign ups, better use default emojis. If you can't, try to keep the emoji names as short as possible (maybe only 1 character).
What If I Can't?
Don't worry! If the field message length is reached, the sign up will not be lost. You can always use /event user get_hidden_users
to get all sign ups.