|
| 1 | +?> We recommend using the [Dashboard](https://carl.gg) as it allows for easier setup and embeds. |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +### Variables |
| 6 | + |
| 7 | +Supports the following variables: |
| 8 | + |
| 9 | +- `{mention}` - Pings the user |
| 10 | +- `{user}` - Name of the user |
| 11 | +- `{server}` - Name of the server |
| 12 | +- `{user(id)}` - ID of the user |
| 13 | +- `{user(proper)}` - Name including the last four digits (Carl-bot#1536) |
| 14 | +- `{server(members)}` - Number of members in the server (after the event has happened). Use `{ord:{server(members)}}` to turn 8102 into 8,102nd etc |
| 15 | +- `{random: separated ~ by ~ tilde}` - Random string from list. It first checks for `~` as separator and if it's not present, it checks for `,`. |
| 16 | +- `{math: 1 + 1}` - Calculate stuff |
| 17 | + |
| 18 | +### Welcome Messages |
| 19 | + |
| 20 | +Carl-bot can send welcome messages to a channel when a user joins the server. You can also DM the user upon joining. |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | +<!-- tabs:start --> |
| 25 | + |
| 26 | +<!-- tab:Prefix Commands --> |
| 27 | + |
| 28 | +| Name | Example | Usage | |
| 29 | +| --------------------------------------------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------------------- | |
| 30 | +| **set welcome** \<channel><br><span class="user-permissions">Manage Server</span> | `!set welcome #welcome` | Sets the channel where welcome notification messages will be posted. | |
| 31 | +| [**welcome**\|**greet**] \<text><br><span class="user-permissions">Manage Server</span> | `!welcome Welcome` | Sets up a welcome message that will be sent when a new user joins. | |
| 32 | +| [**dmjoin**\|**pmjoin**\|**joindm**\|**joinpm**] \<text><br><span class="user-permissions">Manage Server</span> | `!joindm Welcome` | DMs the user upon joining your server. | |
| 33 | + |
| 34 | +<!-- tab:Slash Commands --> |
| 35 | + |
| 36 | +| Name | Example | Usage | |
| 37 | +| ----------------------------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------ | |
| 38 | +| **greetings welcome_channel** \<channel><br><span class="user-permissions">Manage Server</span> | `/greetings welcome_channel #welcome` | Sets the channel where welcome messages will be sent. | |
| 39 | +| **greetings welcome** \<message><br><span class="user-permissions">Manage Server</span> | `/greetings welcome Welcome` | Sets up a welcome message that will be sent when a new user joins. | |
| 40 | +| **greetings joindm** [message]<br><span class="user-permissions">Manage Server</span> | `/greetings joindm Welcome` | DMs the user upon joining your server. | |
| 41 | + |
| 42 | +<!-- tabs:end --> |
| 43 | + |
| 44 | +### Leave Messages |
| 45 | + |
| 46 | +Carl-bot can send leave messages to a channel when a user leaves the server. |
| 47 | + |
| 48 | +<!-- tabs:start --> |
| 49 | + |
| 50 | +<!-- tab:Prefix Commands --> |
| 51 | + |
| 52 | +| Name | Example | Usage | |
| 53 | +| ---------------------------------------------------------------------------------------- | ------------------------- | ----------------------------------------------------------------------------- | |
| 54 | +| **set farewell** \<channel><br><span class="user-permissions">Manage Server</span> | `!set farewell #farewell` | Sets the channel where leave and banmsg notification messages will be posted. | |
| 55 | +| [**leave**\|**farewell**] \<text><br><span class="user-permissions">Manage Server</span> | `!leave Goodbye` | Sets up a leave message that will be sent when a user leaves the server. | |
| 56 | + |
| 57 | +<!-- tab:Slash Commands --> |
| 58 | + |
| 59 | +| Name | Example | Usage | |
| 60 | +| ------------------------------------------------------------------------------------------------ | --------------------------------------- | ------------------------------------------------------------------------ | |
| 61 | +| **greetings farewell_channel** \<channel><br><span class="user-permissions">Manage Server</span> | `/greetings farewell_channel #farewell` | Sets the channel where farewell messages will be sent. | |
| 62 | +| **greetings farewell** [message]<br><span class="user-permissions">Manage Server</span> | `/greetings farewell Goodbye` | Sets up a leave message that will be sent when a user leaves the server. | |
| 63 | + |
| 64 | +<!-- tabs:end --> |
| 65 | + |
| 66 | +### Ban Messages |
| 67 | + |
| 68 | +Ban messages are sent when a user is banned from the server. |
| 69 | + |
| 70 | +<!-- tabs:start --> |
| 71 | + |
| 72 | +<!-- tab:Prefix Commands --> |
| 73 | + |
| 74 | +| Name | Example | Usage | |
| 75 | +| ------------------------------------------------------------------------- | --------------------------- | ------------------------------------------------------------------- | |
| 76 | +| **banmsg** \<text><br><span class="user-permissions">Manage Server</span> | `!banmsg {user} got banned` | Sets up a banmsg message that will be sent when a user gets banned. | |
| 77 | + |
| 78 | +<!-- tab:Slash Commands --> |
| 79 | + |
| 80 | +| Name | Example | Usage | |
| 81 | +| ----------------------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------- | |
| 82 | +| **greetings banmessage** [message]<br><span class="user-permissions">Manage Server</span> | `/greetings banmessage {user} got banned` | Sets up a banmsg message that will be sent when a user gets banned. | |
| 83 | + |
| 84 | +<!-- tabs:end --> |
| 85 | + |
| 86 | +### Testing Messages |
| 87 | + |
| 88 | +To test your welcome, leave and ban messages, you can use the following commands. This will send a welcome, farewell, and ban message to the channel you use this command in. |
| 89 | + |
| 90 | +<!-- tabs:start --> |
| 91 | + |
| 92 | +<!-- tab:Prefix Commands --> |
| 93 | + |
| 94 | +| Name | Example | Usage | |
| 95 | +| -------------------------------------------------------------------- | ------------ | ------------------------------------------------- | |
| 96 | +| **testgreet**<br><span class="user-permissions">Manage Server</span> | `!testgreet` | Sends a welcome, farewell and banmsg for testing. | |
| 97 | + |
| 98 | +<!-- tab:Slash Commands --> |
| 99 | + |
| 100 | +| Name | Example | Usage | |
| 101 | +| ------------------------------------------------------------------------------ | ---------------------- | ------------------------------------------------- | |
| 102 | +| **greetings testgreet**<br><span class="user-permissions">Manage Server</span> | `/greetings testgreet` | Sends a welcome, farewell and banmsg for testing. | |
| 103 | + |
| 104 | +<!-- tabs:end --> |
0 commit comments