forked from EllieBotDevs/EllieBot-docs
1 line
No EOL
21 KiB
JSON
1 line
No EOL
21 KiB
JSON
{"config":{"lang":["en"],"separator":"[\\s\\-,:!=\\[\\]()\"/]+|(?!\\b)(?=[A-Z][a-z])|\\.(?!\\d)|&[lg]t;","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Elliebot Documentation","text":"<p>This site will now be hosting user guides for EllieBot v3</p> <p> Add Ellie to your server View commands</p> <p> Ellie's website Blog</p>"},{"location":"coming_soon/","title":"Coming soon","text":""},{"location":"coming_soon/#this-section-of-the-documentation-is-coming-soon","title":"This section of the documentation is coming soon!","text":""},{"location":"contributing/","title":"Hey there!","text":"<p>If you are on this page that means you either want to help us or you are just curious about our project our contribution steps for the Ellie bot project are below</p>"},{"location":"contributing/#contribution-steps","title":"Contribution steps","text":"<pre><code>1.Fork the repository\n2.Clone your fork: git clone https://github.com/your-username/Ellie-bot.git\n3.Create your feature branch: git checkout -b my-new-feature\n4.Commit your changes: git commit -am 'Add some feature'\n5.Push to the branch: git push origin my-new-feature\n6.Submit a pull request\n</code></pre> <p>All contributions are welcome!</p> <p>Thanks in advance</p>"},{"location":"credits/","title":"Credits","text":""},{"location":"credits/#we-would-like-to-thank-these-people-for-the-projects-that-powers-this-documentation","title":"We would like to thank these people for the projects that powers this documentation","text":"<p>MkDocs for creating mkdocs cause without them this documentation would not be possible</p> <p>squidfunk for creating mkdocs-material the theme that this site uses</p>"},{"location":"Giveaway-Child/Commands/","title":"Commands","text":"<p>Note</p> <p>This page here is scheduled for an update.</p>"},{"location":"Giveaway-Child/Commands/#giveaway-commands","title":"Giveaway Commands","text":"<ol> <li>/start [channel-name] [Time] [winners] [Prize]</li> <li>/reroll [giveawayid]</li> <li>/end [prize name]</li> </ol>"},{"location":"Giveaway-Child/Commands/#examples","title":"Examples","text":"<ol> <li>/start #giveaway 5m 1 Testing</li> <li>/end Testing</li> <li>/reroll Testing</li> </ol>"},{"location":"SupportChild/Commands/","title":"Commands","text":"Command Description <code>/add <user></code> Add users to the ticket. <code>/addcategory <title> <category></code> Adds a category for users to open tickets in. The title is what will be used on buttons and in selection menus. <code>/addmessage <identifier> <message></code> Adds a new message for the <code>say</code> command. The identifier is one word used in the say command and the message is what the bot prints. <code>/addstaff <user></code> Registers a user as a staff member for ticket assignment. <code>/assign (user)</code> Assigns a ticket to a staff member, themself if no mention or id is provided. <code>/blacklist <user></code> Blacklists users from opening tickets. <code>/close</code> Closes a ticket channel and posts a ticket transcript in the log channel. <code>/createbuttonpanel</code> Creates a panel of buttons for users to open tickets with, one for each saved category. <code>/createselectionbox (message)</code> Creates a selection menu for users to open tickets with. Message is the placeholder shown on the selection menu before anything is selected. <code>/list (user)</code> Lists a user's open and closed tickets. <code>/listassigned (user)</code> Lists all of a staff member's assigned tickets. <code>/listopen</code> Lists a number of the oldest still open tickets, default is 20. <code>/listunassigned</code> Lists all unassigned tickets. <code>/move <category></code> Moves a ticket to a specific category by partial name. <code>/new</code> Opens a new ticket channel. <code>/rassign (role)</code> Randomly assigns a ticket to an active staff member. If a role is provided only staff member with that role are considered. <code>/removecategory <category></code> Removes a category from the bot. <code>/removemessage <identifier></code> Removes message from the database. <code>/removestaff <user></code> Removes a user from staff. <code>/say (identifier)</code> Prints a message with information from staff. Use with no arguments to list ids. <code>/setsummary <summary></code> Sets a summary for a ticket which can be viewed using the <code>summary</code> command. <code>/status</code> Shows a status message about the bot with info such as number of tickets and which version is running. <code>/summary</code> Shows some information about a ticket and its summary if set. <code>/toggleactive (user)</code> Toggles whether a staff member counts as active or not. <code>/transcript (ticket id)</code> Generates a ticket transcript as an html file. <code>/unassign</code> Unassigns a ticket from the currently assigned staff member. <code>/unblacklist <user></code> Un-blacklists users from opening tickets. <code>/admin listinvalid</code> Lists tickets which channels have been deleted, you can use the <code>/admin unsetticket</code> command to remove them from the ticket system. <code>/admin reload</code> Reloads the config. <code>/admin setticket (channel)</code> Makes the current channel a ticket. <code>/admin unsetticket (ticket id)</code> Removes a ticket without deleting the channel."},{"location":"other-things/timestamps/","title":"Timestamps","text":"<p>This page will soon be moved to a different docs site.</p>"},{"location":"other-things/timestamps/#how-to-use-timestamps","title":"How to use timestamps","text":"<p>Here is some stuff that culd help</p> <p>Unix epoch time converter <pre><code><t:1624855717> short date time: June 27, 2021 9:48 PM\n<t:1624855717:f> short date time June 27, 2021 9:48 PM\n<t:1624855717:F> long date time: Sunday, June 27, 2021 9:48 PM\n<t:1624855717:d> short date: 06/27/2021\n<t:1624855717:D> long date: June 27, 2021\n<t:1624855717:t> short time: 9:48 PM\n<t:1624855717:T> long time: 9:48:37 PM\n<t:1624855717:R> relative time: 2 days ago\n</code></pre></p> <p>Step 1</p> <p>Look to how it is shown below and copy that but with your current date and time </p> <p>Step 2</p> <p>Then type it into Discord as shown below</p> <p></p>"},{"location":"v4/custom-reactions/","title":"Expressions","text":""},{"location":"v4/custom-reactions/#important","title":"Important","text":"<ul> <li>For modifying global custom reactions, the ones which will work across all the servers Ellie is connected to, you must be a Bot Owner. You must also use the commands for adding, deleting and listing these reactions in a direct message with the bot.</li> <li>For modifying local custom reactions, the ones which will only work on the server that they are added on, it is required to have the Administrator permission. You must also use the commands for adding, deleting and listing these reactions in the server you want the custom reactions to work on.</li> </ul>"},{"location":"v4/custom-reactions/#commands-and-their-use","title":"Commands and Their Use","text":"Command Name Description Example <code>'exa</code> Add an expression with a trigger and a response. Running this command in a server requries the Administrator permission. Running this command in DM is Bot Owner only, and adds a new global expression. <code>'exadd \"hello\" Hi there, %user%!</code> <code>'exl</code> Lists a page of global or server expression(15 expressions per page). Running this command in a DM will list the global expression, while running it in a server will list that server's expression. <code>'exl 1</code> <code>'exd</code> Deletes an expression based on the provided index. Running this command in a server requires the Administrator permission. Running this command in DM is Bot Owner only, and will delete a global expression. <code>'exd 5</code>"},{"location":"v4/custom-reactions/#now-that-we-know-the-commands-lets-take-a-look-at-an-example-of-adding-a-command-with-exa","title":"Now that we know the commands let's take a look at an example of adding a command with <code>'exa</code>,","text":"<p><code>'exadd \"Nice Weather\" It sure is, %user%!</code></p> <p>This command can be split into two different arguments:</p> <ul> <li>The trigger, <code>\"Nice Weather\"</code></li> <li>And the response, <code>It sure is, %user%!</code></li> </ul> <p>An important thing to note about the triger is that, to be more than one word, we had to wrap it with quotation marks, <code>\"Like this\"</code> otherwise, only the first word would have been recognised as the trigger, and the second word would have been recognised as part of the response.</p> <p>There's no special requirement for the formatting of the response, so we could just write it in exactly the same way we want it to respond, albeit with a placeholder - which will be explained in this next section.</p> <p>Now, if that command was ran in a server, anyone on that server can make the bot mention them, saying <code>It sure is, @Username</code> anytime they say \"Nice Weather\". If the command is ran in a direct message with the bot, then the expression can be used on every server the bot is connected to.</p>"},{"location":"v4/custom-reactions/#block-global-expressions","title":"Block global Expressions","text":"<p>If you want to disable a global expression which you do not like, and you do not want to remove it, or you are not the bot owner, you can do so by adding a new expression with the same trigger on your server, and set the response to <code>-</code>.</p> <p>For example: <code>'exa /o/ -</code></p> <p>Now if you try to trigger <code>/o/</code>, it won't print anything even if there is a global expression with the same name.</p>"},{"location":"v4/custom-reactions/#placeholders","title":"Placeholders!","text":"<p>To learn about placeholders, go here</p>"},{"location":"v4/permissions-system/","title":"Permissions Overview","text":"<p>Have you ever felt confused or even overwhelmed when trying to set Nadeko's permissions? In this guide we will be explaining how to use the permission commands correctly and even cover a few common questions! Every command we discuss here can be found in the Commands List.</p>"},{"location":"v4/permissions-system/#why-do-we-use-the-permissions-commands","title":"Why do we use the Permissions Commands?","text":"<p>Permissions are very handy at setting who can use what commands in a server. All commands and modules are enabled by default. If something is a bot owner only command, it can only be ran by the bot owner</p> <p>Several commands still require that you have the correct permissions on Discord to be able to use them, so for users to be able to use commands like <code>'kick</code> and <code>'voicemute</code>, they need Kick and Mute Members server permissions, respectively.</p> <p>With the permissions system it possible to restrict who can skip the current song, pick NadekoFlowers or use the NSFW module.</p>"},{"location":"v4/permissions-system/#first-time-setup","title":"First Time Setup","text":"<p>To change permissions you must meet the following requirements:</p> <p>Have Administrator Server Permission.</p> <p>If you are NOT the server owner or an admin, get the role set to <code>'permrole</code> (there is no permission role by default).</p>"},{"location":"v4/permissions-system/#basics-hierarchy","title":"Basics & Hierarchy","text":"<p>The Commands List is a great tool which lists all available commands, however we'll go over a few of them here.</p> <p>First, let's explain how the permissions system works - It's simple once you figure out how each command works! The permissions system works as a chain. Everytime a command is used, the permissions chain is checked. Starting from the top of it, the command is compared to a rule, if it isn't either allowed or disallowed by that rule it proceeds to check the next rule all the way till it reaches the bottom rule, which allows all commands.</p> <p>To view this permissions chain, do <code>'lp</code>. The rule at the top of the chain takes priority over all rules below it.</p> <p>If you want to remove a permission from the chain of permissions, do <code>'rp X</code> to remove rule number X and similarly, do <code>'mp X Y</code> to move rule number X to number Y (moving, not swapping!).</p> <p>If you want the bot to notify users why they can't use a command or module, use <code>'verbose true</code> and Ellie will tell you what rule is preventing the command from being used.</p>"},{"location":"v4/permissions-system/#commonly-asked-questions","title":"Commonly Asked Questions","text":""},{"location":"v4/permissions-system/#how-do-i-restrict-all-commands-to-a-single-channel","title":"How do I restrict all commands to a single channel?","text":"<p>To allow users to only use commands in a specific text channel, follow these steps:</p> <ol> <li><code>'asm disable</code><ul> <li>Disables all modules on the entire server</li> </ul> </li> <li><code>'acm enable #bot-spammerino</code><ul> <li>Enables all modules in the #bot-spammerino channel</li> </ul> </li> </ol>"},{"location":"v4/permissions-system/#how-do-i-allow-only-one-module-to-be-used-in-a-specific-channel","title":"How do I allow only one module to be used in a specific channel?","text":"<p>To allow users to only use commands from a certain module, let's say gambling, in a specific text channel, follow these steps:</p> <ol> <li><code>'acm disable #gamblers-den</code><ul> <li>Disables all modules in the #gamblers-den channel</li> </ul> </li> <li><code>'cm Gambling enable #gamblers-den</code><ul> <li>Enables usage of the Gambling module in the #gamblers-den channel</li> </ul> </li> </ol>"},{"location":"v4/permissions-system/#how-do-i-create-a-music-dj","title":"How do I create a music DJ?","text":"<p>To allow users to only see the current song and have a DJ role for queuing follow these steps:</p> <ol> <li><code>'sm Music disable</code><ul> <li>Disables music commands for everybody</li> </ul> </li> <li><code>'sc .nowplaying enable</code><ul> <li>Enables the \"nowplaying\" command for everyone</li> </ul> </li> <li><code>'sc .listqueue enable</code><ul> <li>Enables the \"listqueue\" command for everyone</li> </ul> </li> <li><code>'rm Music enable DJ</code><ul> <li>Enables all music commands only for the DJ role</li> </ul> </li> </ol>"},{"location":"v4/permissions-system/#how-do-i-create-a-nsfw-role","title":"How do I create a NSFW role?","text":"<p>Say you want to only enable NSFW commands for a specific role, just do the following two steps.</p> <ol> <li><code>'sm NSFW disable</code><ul> <li>Disables the NSFW module from being used</li> </ul> </li> <li><code>'rm NSFW enable Lewd</code><ul> <li>Enables usage of the NSFW module for the Lewd role</li> </ul> </li> </ol>"},{"location":"v4/permissions-system/#how-do-i-disable-expressions-from-triggering","title":"How do I disable Expressions from triggering?","text":"<p>If you don't want server or global Expressions, just block the module that controls their usage:</p> <ol> <li><code>'sm ActualExpressions disable</code><ul> <li>Disables the ActualExpression module from being used</li> </ul> </li> </ol> <p>Note: The <code>Expressions</code> module controls the usage of Expressions. The <code>Expressions</code> module controls commands related to Expressions (such as <code>'acr</code>, <code>'lcr</code>, <code>'crca</code>, etc).</p>"},{"location":"v4/permissions-system/#ive-broken-permissions-and-am-stuck-can-i-reset-permissions","title":"I've broken permissions and am stuck, can I reset permissions?","text":"<p>Yes, there is a way, in one easy command!</p> <ol> <li><code>'resetperms</code><ul> <li>This resets the permission chain back to default</li> </ul> </li> </ol>"},{"location":"v4/placeholders/","title":"Placeholders","text":"<p>Placeholders are used in Quotes, Expressions, Greet/Bye messages, playing statuses, and a few other places.</p> <p>They can be used to make the message more user friendly, generate random numbers or pictures, etc.</p> <p>Some features have their own specific placeholders which are noted in that feature's command help. Some placeholders are not available in certain features because they don't make sense there.</p>"},{"location":"v4/placeholders/#usual-placeholders","title":"Usual placeholders","text":"<p>Note</p> <p>If you're using placeholders in embeds, don't use %user.mention% and %bot.mention% in titles, footers and field names. They will not show properly.</p>"},{"location":"v4/placeholders/#bot-placeholders","title":"Bot placeholders","text":"<ul> <li><code>%bot.status%</code> - Bot's status (Online, Idle, DoNotDisturb, Invisible)</li> <li><code>%bot.latency%</code> - Bot latency</li> <li><code>%bot.name%</code> - Bot username</li> <li><code>%bot.mention%</code> - Bot mention (clickable)</li> <li><code>%bot.fullname%</code> - Bot username#discriminator</li> <li><code>%bot.time%</code> - Bot time (usually the time of the server it's hosted on)</li> <li><code>%bot.discrim%</code> - Bot's discriminator</li> <li><code>%bot.id%</code> - Bot's user ID</li> <li><code>%bot.avatar%</code> - Bot's avatar url</li> </ul>"},{"location":"v4/placeholders/#server-placeholders","title":"Server placeholders","text":"<ul> <li><code>%server.id%</code> - Server ID</li> <li><code>%server.name%</code> - Server name</li> <li><code>%server.members%</code> - Member count</li> <li><code>%server.boosters%</code> - Number of users boosting the server</li> <li><code>%server.boost_level%</code> - Server Boost level</li> <li><code>%server.time%</code> - Server time (requires <code>'timezone</code> to be set)</li> </ul>"},{"location":"v4/placeholders/#channel-placeholders","title":"Channel placeholders","text":"<ul> <li><code>%channel.mention%</code> - Channel mention (clickable)</li> <li><code>%channel.name%</code> - Channel name</li> <li><code>%channel.id%</code> - Channel ID</li> <li><code>%channel.created%</code> - Channel creation date</li> <li><code>%channel.nsfw%</code> - Returns either <code>True</code> or <code>False</code>, depending on if the channel is designated as NSFW using discord</li> <li><code>%channel.topic%</code> - Channel topic</li> </ul>"},{"location":"v4/placeholders/#user-placeholders","title":"User placeholders","text":"<ul> <li><code>%user.mention%</code> - User mention</li> <li><code>%user.fullname%</code> - Username#discriminator</li> <li><code>%user.name%</code> - Username</li> <li><code>%user.discrim%</code> - Discriminator</li> <li><code>%user.avatar%</code> - User's avatar url</li> <li><code>%user.id%</code> - User ID</li> <li><code>%user.created_time%</code> - Account creation time (local time)</li> <li><code>%user.created_date%</code> - Account creation date</li> <li><code>%user.joined_time%</code> - Account join time (local time)</li> <li><code>%user.joined_date%</code> - Account join date</li> </ul>"},{"location":"v4/placeholders/#ban-message-placeholders","title":"Ban message placeholders","text":"<ul> <li><code>%ban.mod%</code> - Full name of the moderator who performed the ban </li> <li><code>%ban.mod.fullname%</code> - Full name of the moderator who performed the ban </li> <li><code>%ban.mod.mention%</code> - Moderator's mention </li> <li><code>%ban.mod.name%</code> - Name of the moderator - Admin </li> <li><code>%ban.mod.discrim%</code> - Discriminator of the moderator - 1234 </li> <li><code>%ban.user%</code> - Full name of the banned user </li> <li><code>%ban.user.fullname%</code> - Full name of the banned user </li> <li><code>%ban.user.name%</code> - Name of the banned user </li> <li><code>%ban.user.discrim%</code> - Discriminator of the banned user </li> <li><code>%ban.reason%</code> - Reason for the ban, if provided </li> <li><code>%ban.duration%</code> - Duration of the ban in the form Days.Hours:Minutes (6.05:04) </li> </ul>"},{"location":"v4/placeholders/#shard-stats-placeholders","title":"Shard stats placeholders","text":"<ul> <li><code>%shard.servercount%</code> - Server count on current shard</li> <li><code>%shard.usercount%</code> - Combined user count on current shard</li> <li><code>%shard.id%</code> - Shard ID</li> </ul>"},{"location":"v4/placeholders/#music-placeholders","title":"Music placeholders","text":"<ul> <li><code>%music.queued%</code> - Number of songs currently queued</li> <li><code>%music.playing%</code> - Current song name (random playing song if bot is playing on multiple servers)</li> <li><code>%music.servers%</code> - Number of servers currently listening to music</li> </ul>"},{"location":"v4/placeholders/#miscellaneous-placeholders","title":"Miscellaneous placeholders","text":"<ul> <li><code>%rngX-Y%</code> - Returns a random number between X and Y</li> <li><code>%target%</code> - Returns anything the user has written after the trigger (only works on Expressions)</li> </ul>"},{"location":"v5/coming_soon/","title":"Installation","text":""},{"location":"v5/coming_soon/#this-section-of-the-documentation-is-coming-soon","title":"This section of the documentation is coming soon!","text":""}]} |