Modules Documentation 101
Note
New to the bot? Start with the Quick Start guide, then come back here for the notation used throughout these docs.
The docs use a set of conventions to describe commands, parameters, and durations. This page lists them.
Server/Guild, Channel, Message, Role, User IDs
Each entity in Discord has a unique ID. Many bot features take an ID as an argument, so you need to know where to find one. Getting an ID also requires that you have Discord's Developer Mode active.
Many guides cover enabling Developer Mode and getting an ID. This link goes to the official Discord support page on the topic.
You can get a role ID by putting \ before a role mention, but the message still mentions the role. Most slash-command options do not need this at all: Discord's own autocomplete lets you pick a user, channel, or role directly, and only options that ask for a raw ID (like /owner guild leave server_id) need one pasted in by hand.
Command Syntax Notation
Throughout this documentation, a command's syntax is shown as a single invocation line, for example:
/ban user:{user} [reason:{text}] [rule:{rule}] [duration:{time code}] [delay:{time code}] [delete_days:{0-7}] | Notation | Meaning |
|---|---|
name:{value} | A required option, no brackets. |
[name:{value}] | Optional - safe to omit entirely. |
{value} | A placeholder description of what to type there, not literal text - user:{user} means "put a user mention/ID/name here", not the literal word "user". |
These are real Discord slash commands, so you never need to memorize this notation: typing / followed by the command name shows every option, its description, and whether it is required, inside Discord as you type.
Finding things
Press Ctrl+K (or Cmd+K on macOS) anywhere in these docs, or use the search button next to the bot selector. Command results come first: type ban or /ban to jump straight to a command, or any other word to find the pages that mention it.
Content Policy
GiselleBot is meant to be used within the rules of the [Terms of Service](/terms), [Discord's Terms of Service](https://discord.com/terms) and [Discord's Community Guidelines](https://discord.com/guidelines).What is not allowed
- NSFW content: pornography and sexually explicit or excessively sexual material, excessive gore or extreme violence, and content promoting or glorifying self harm, suicide or harming others.
- Sexual content involving minors, real or drawn/animated, under any circumstances.
- Illegal content, including pirated or illegally acquired material.
- Hateful, harassing, obscene or otherwise offensive content.
Where it applies
This applies to everything the bot sends, stores or processes on your behalf, in every module, whether you type it in a command, or set it up in the dashboard. That includes messages sent through GiselleBot, greeting and verification messages, form questions and messages, reminders, embeds, and any image or file you attach. Moderation case evidence is stored differently from other uploads; see Moderation evidence is re-uploaded below.
You are responsible for the custom content you configure or send through GiselleBot in your server, and the owners of the bot are not liable for content created by third parties through its features. This is why greeting and verification messages carry a disclaimer pointing to the Terms of Service.
Automatic checks
Where a feature accepts images, they may be automatically checked, and anything flagged as NSFW is dropped instead of being processed or delivered. For example, /send message and the dashboard's Message Composer drop the whole message if one of its attached images is flagged, and the AutoModerator's NSFW Images trigger lets a server act on NSFW images posted by its members.
Note
Automatic detection is a best-effort check. It does not replace the server's own rules and moderators.
Moderation evidence is re-uploaded
Attachments on a moderation case are copied into your server. When a moderator attaches a file to /warn, /ban, /kick, /mute, /case edit, or schedules a ban with delay, GiselleBot downloads it, checks its type and size, runs the NSFW check, and scans it for malware. If it passes, the bot uploads it again as a message in the server's warning log channel, and the case links to that message instead of Discord's expiring upload link.
The moderator who attached the file is responsible for it. The file becomes content in your server, readable by everyone who can see the warning log channel. The automatic checks catch unsupported file types, oversized files, images flagged as NSFW, and malware. They say nothing about whether a file is lawful or appropriate for your server, and a moderator can attach the wrong screenshot or something that should never have been stored.
If a file should not stay, delete the evidence message in the warning log channel. The clear_attachments option on /case edit only removes the link from the case; the uploaded message stays until someone deletes it.
Reporting and enforcement
Report any offensive, inappropriate, obscene, unlawful or otherwise objectionable content you come across in the bot's features as soon as possible. The bot's owners may act on that content, and on the people who posted it, at their discretion, including interrupting the service for the users involved.
Some features are explicitly marked as NSFW, and should only be used by people who are old enough to access such content in their country.
Premium Notes
A bolded Premium note on a page means that feature, or a higher limit for it, needs a Premium subscription on the server it is used in. Premium applies to a server, not to an account, and every one of those notes links to Premium Perks, which lists the two tiers, their prices, and what each one raises.
Time Format Code
Standard Time Code
Time durations use a standard format made of 5 (or 6) time bits:
| Time Bit | Meaning |
|---|---|
mo | month(s) |
w | week(s) |
d | day(s) |
h | hour(s) |
m | minute(s) |
A time code can also carry an extra bit, s for second(s). Each time bit needs a positive integer in front of it, or is left out when its value is 0.
Warning
Write the time bits in the correct order: mo > w > d > h > m > s
A typical time code looks like this:
2mo6h40m = 2 months, 6 hours, 40 minutes Timestamp Mentions
A standard time code gives a duration directly, such as 3 hours or 10 minutes from now. Commands that take a time code also accept a "timestamp mention" (refer to Message Formatting, "Unix Timestamp" or "Unix Timestamp (Styled)").
When you use a timestamp mention in place of a time code, GiselleBot converts the timestamp into the matching "time from now" interval and uses it as the span.
This helps when you want an action at a particular time of day, as with reminders, repeating messages, and scheduled commands.
Note
You can create these timestamp mentions in Discord-ready syntax with HammerTime by WentTheFox.
Warning
A timestamp mention works as a time code only if it points to a future date.