> For the complete documentation index, see [llms.txt](https://litochee.gitbook.io/amaribot/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://litochee.gitbook.io/amaribot/getting-started.md). # Getting Started {% hint style="info" %} If you are having any issues setting up features have a read through [FAQ.](/amaribot/faq.md) {% endhint %} #### This guide will cover the basics you need to do to get started with AmariBot. ### 1. Setup Prefix If you want the bot to respond to the prefix `?`, you can do so using `:?prefix ?`. The prefix cannot be longer than 6 characters. ### 2. Setup Level Roles Users can earn roles by reaching certain levels, this can be set up using the `:?rlevel` command. We can add roles using `:?rlevel add <@role>`.\ \ When setting up `rlevel` rewards make sure the AmariBot role is above all the roles you are assigning:
### 3. Custom Announcements Server admins can set up custom announcements for when users level up. Using the `:?announce` command you can set up custom announcements for each level or set up an announcement for all levels. You can use `:?announce custom ` to set up the message. The following shows an example of the command to use and the output for the command , `:?announce custom CONGRATS You are now level`\ `{level}!!!`
Announcement example
Custom announcements can be also used to set up announcements for each level, this will allow you to mention the role the user earns for that level. Example of command, `:?announce level add ` `` will allow you to set up the custom announcement for specific levels. You can also check which levels have custom announcements using `:?announce level show` #### Announce Syntax `{role}` (Obtained role) (`:?announce level` only) \ `{user}` (AmariBot)\ `{user.tag}` (AmariBot#5150) \ `{user.ping}` (@AmariBot)\ `{level}`(Obtained level) ### 4. Blacklisting Channels & Roles Everyone has those spam command channels, so you can use the `:?blacklist` command to stop users from gain EXP from all the spam messages. Using `:?blacklist` you can either blacklist channels or roles. To add channels to the blacklist run `:?blacklist add #channel` and to add a role you can run `:?blacklist add @role` ### 5. Weekly Leaderboard Weekly command can be used to track user activity over a smaller period of time, we usually set this up to give out rewards but you can use it for what ever you want. If you want to set up weekly you can use `:?weekly on` and use `:?weekly winners` to get a nice image of the top 3 winners.
This is just a few of the features AmariBot offers, but this guide allows you to set up the cores features and from here you can [invite](https://discordapp.com/oauth2/authorize?client_id=339254240012664832\&scope=bot\&permissions=268954688) the bot and check out all the other features. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://litochee.gitbook.io/amaribot/getting-started.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.