# Index
- Commands you'll want to know
- First thing's first: cards
- Expeditions 101
- Supplying your expeditions

## Commands you'll want to know
Command and Syntax | Description | Usage
----------------|--------------|-------
`/cards pull` | Pull a card from Miki's large collection of cards! | `/cards pull`
`/cards mine` | View your collection of cards. | `/cards mine`
`/cards party new` | Create a party using your cards! | `/cards party new (name) (member1) (member2) (member3) (member4)`
`/expeditions new` | Send a new party on an expedition. | `/expeditions new (expedition) (party)`
`/craft cook` | Prepare ingredients or make a delicious dish. | `/craft cook`
`/craft status` | Check on your active crafting jobs. | `/craft status`
`/expeditions status` | Check on your expeditions! | `/expeditions status`
`/expeditions supply` | Send supplies to your expedition party. | `/expeditions supply`

## First thing's first: cards
To start with expeditions, you first need a minimum of 4 cards to form an expedition party. 
Run the command `/cards pull` to pull a random card based on [Miki's pool of cards](https://miki.bot/cards/list). 

![](/images/expeditions/cardspull.png) 
 
Keep in mind that each card pull has a 10-minute cooldown. 

To check which cards you have, use the `/cards mine` command. This will bring up a paginated list to show you all your cards. 
Once you have 4 cards, you are now ready to form your first expedition party! 

To get started, type in the command `/cards party new`. This command will require 4 inputs before you can run the command. 

![](/images/expeditions/cardspartynew.png) 
 
For each of the arguments:
- `name`: Input your party name.
- `member1`: Input your first member of your party.
- `member2`: Input your second member of your party.
- `member3`: Input your third member of your party.
- `member4`: Input your fourth member of your party.

This is the party we'll use to start our first expedition. 

For more information on cards, please check the guide here (coming soon). 

## Expeditions 101
Expeditions are a way for you to get new loot using parties formed by your cards. These rewards can be anything from new crafting materials to card borders and more. 

Using the party we formed with our cards, you can form a temporary expedition party using the command `/expeditions new`. 

![](/images/expeditions/expeditionsnew.png) 
 
For each of the arguments:
- `expedition`: Choose one of the areas to send your party to. Different areas will yield different rewards.
- `party`: Select which party to send out.

If done correctly, your command should look something like this: 
![](/images/expeditions/expeditionsnewfilled.png) 
 
![](/images/expeditions/expeditions.png) 
Once sent, your expedition party will return in 3 hours with some shiny new loot! 

![](/images/expeditions/expeddone.png) 
![](/images/expeditions/expeddone2.png) 
 

## Supplying your expeditions
If you want to maximize the loot your expedition parties get, you will definitely want to start supplying your expeditions. 
To supply your expeditions, you need food. To start off supplying your expeditions early on, one of the simplest ways to start supplying your expeditions is by using something like fish. 
Unsure where to obtain fish? Check out our [fishing guide](https://miki.bot/guides/how-to-fish-using-miki)! 
Using the command `/craft cook`, we can select the "Cooked Fish" option in the "Select a recipe to craft" menu. 

![](/images/expeditions/craftcook.png) 
 
Once selected, the menu should look something like such. Press the blue "Craft" button, and in 1 minute, you will have your cooked fish! 

![](/images/expeditions/craftcook2.png) 
 
In order to check on the status of your fish, run the command `/craft status`. 
This will bring up a menu which will show you how long you have left until you can claim your fish. 

![](/images/expeditions/craftstatus.png) 
 
Once the box turns green with a checkmark, you may click the button to claim your fish! 

![](/images/expeditions/craftstatus2.png) 
 

Using this Cooked Fish, you are now able to supply your expedition with some food. 
Run the `/expeditions supply` command, and in the "Select items to send" dropdown menu, select your newly Cooked Fish. 

![](/images/expeditions/supply.png) 
 
A piece of Cooked Fish will only supply your expedition with `3%` supplies. Cooked Fish is certainly not the most efficient way to supply your expeditions, but early on, it certainly is one of the easiest ways to provide your expeditions with a small amount of supplies. 

This process may be repeated with the same item or different items to provide even more supplies to your expedition party. 
Remember, the more you supply, the more you get out of your expedition! Supplying your expedition to `100%` will provide you with rare drops, and supplying your expedition from `90-99%` will result in more common drops.

How to Start With Expeditions!

# Index
- Commands you'll want to know
- Pre-requisites
- Getting started with fishing using Miki
- Biomes? Fish rarity? What's that?
- What do I do with my fish?

## Commands you'll want to know
Command and Syntax | Description | Usage
----------------|--------------|-------
`/fish` | Catch fish with your fishing rod. You can sell them later! | `/fish`
`/collection fishing` | View all your fishing-related collected items. | `/collection fishing`
`/guild info` | Check cool information about your server and its users! | `/guild info`
`/shop buy` | Wanna see what Miki has for sale for you? Buy it here. | `/shop buy`
`/shop sell` | Sell your valuables for Mekos! | `/shop sell`

## Pre-requisites
In order to fish using Miki, you will want at least 500 Mekos. 
Missing the necessary Mekos? Try using the `/daily` command for some free Mekos. 

## Getting started with fishing using Miki
First, to get started with fishing using Miki, you will need a fishing rod. To start you off, a basic fishing rod will do. 
In order to get your fishing rod, you'll want to use the command `/shop buy` and select "Basic Fishing Rod" for 500 Mekos. 
 
![](images/how-to-fish-using-miki/1.png)
 
Congratulations, you are now ready to start fishing using Miki! To begin your fishing journey, use the command `/fish`. Depending on your luck and server biome, you will catch a random fish. 
 
![](images/how-to-fish-using-miki/2.png)
 
This is what you'll initially see when using the `/fish` command. 
![](images/how-to-fish-using-miki/3.png)
 
Get ready to click the highlighted "Reel in" button! 
![](images/how-to-fish-using-miki/4.png)
 
Assuming all of the above steps were executed properly, congratulations on successfully catching fish! 
Be mindful that even fish need a break! Between each `/fish` attempt, there is an 8-minute cooldown. Attempting to use the command while on cooldown will give you an error!

## Biomes? Fish rarity? What's that?
Let's start with biomes. Whenever Miki is invited to a new guild (a.k.a. servers), that server is assigned a random biome out of six possible choices: 
- Mountain
- Forest
- Tropical
- Sky
- Plains
- Volcanic

You can check your server's assigned biome by using the `/guild info` command. 

![](images/how-to-fish-using-miki/guild_info.png)

The type of fish you get using the `/fish` command is dependent on the biome of your server. 
If you want to check your collection of fish, you can use the command `/collection fishing` and then using the dropdown menu, pick which biome's collection you want to see. 

![](images/how-to-fish-using-miki/collection1.png)
 
This is the initial prompt you'll see when using the command. Collection progress will differ. 
![](images/how-to-fish-using-miki/dropdown.png)
 
Select a biome to check that biome's fish collection! 
![](images/how-to-fish-using-miki/collection2.png)
 
Once selected, Miki will display the fish you've seen for that biome. 
As you can see, there are three tiers of rarity for fish:
- Common
- Uncommon
- Rare

Try your luck and see what you get!

## What do I do with my fish?
Once you catch a new type of fish, it will be registered in your collection automatically. 
One of the things you can do with your caught fish is if you're running low on Mekos, you can sell the fish you caught using `/shop sell`. 
Even after a fish is sold, it will stay registered in your collection! 

![](images/how-to-fish-using-miki/sell1.png)
 
![](images/how-to-fish-using-miki/sell2.png)
 
Using the dropdown, select an item from your inventory you wish to sell. 
![](images/how-to-fish-using-miki/sell3.png)
 
Once selected, the "Sell" button will become highlighted and Miki will offer you a certain amount of Mekos for your item. 
![](images/how-to-fish-using-miki/sell4.png)
 
If you're certain about wanting to sell that item, go ahead and click the blue "Sell" button. 
Ta-da, you've just made some Mekos for fishing!

How to Fish Using Miki!

Veld


When voting, Miki will by default remind you in the next interval when your timer reaches to zero. This is a feature to help users who enjoy getting the rewards for Miki. 

## Can I turn this off?

Yes, you can use `/usersettings togglevotereminders enabled:False` to disable automatic reminders. 

## I voted and now I have a reminder scheduled, can I remove this?

Yes, you can use `/reminder list` and then `/reminder clear reminder:{reminder title here}` to clear your current voting reminder.



Voting Reminders

xRappy, DrFineSir

Command and Syntax | Description | Usage
----------------|--------------|-------
`/ban <@user> [reason]` | Bans someone from the server. | `/ban @xRappy`
`/clean` | Removes all messages in the last 100 messages from Miki. | `/clean`
`/kick <@user> [reason]` | Kicks someone from the server. | `/kick @xRappy`
`/prune <amount>` | Removes all messages in the last X messages. | `/prune 15`
`/prune <amount> <@user>` | Removes all messages in the last X messages from a certain user. | `/prune 15 @Rappy`
`/softban <@user> [reason]` | Bans the user and unbans the user immediately after. | `/softban @IA`


For more permission management, check out [this guide](/guides/mikis-permission-system)!

Admin module

xRappy

Accounts is one big module that keeps track of anything related to your account.

## Leaderboards
Leaderboards returns the top 12 global users based on selected command switches: 

`/leaderboards <page number>` - returns top global users sorted by the amount of Exp they have. 
`/leaderboards local <page number>` - returns top users in your server sorted by the amount of Exp they have. 
`/leaderboards mekos <page number>` - returns top global users sorted by the amount of Mekos they have. 
`/leaderboards commands <page number>` - returns top global users sorted by the number of commands they have used. 
`/leaderboards rep <page number>` - returns top global users sorted by the number of rep they have.

## Profile
Profile shows all information about your account: 

`/profile` - shows your profile 
`/profile <@user>` - shows the mentioned person's profile 
`/profile <user ID>` - shows the profile of the person with that user ID 

## Backgrounds
Backgrounds are what you see in your `/exp` profile card.

`/background list` - See what backgrounds you own 
`/background buy <number>` - Buy that background ID. 
`/background set <number>` - Set your background to that background ID. 

## Database Commands
Database-related command: 

`/syncname` - If your username isn't the same as the one in the database, do this. 

## Money Commands
Commands that involve the use of mekos: 

`/daily` - gives you a daily reward of 100 mekos (23 hour cooldown with 20 mekos more per day of streak (40 for donators)). 
`/give @user <amount>` - gives mekos to another person. 
`/mekos` or `/bal` - checks your balance. 
`/mekos @user` or `/bal @user` - check another person's balance.

## Other Commands
Commands that aren't in any category but it is in the `Accounts` module: 

`/rep <@user>` - Give someone reputation points. You can give 3 reputation points per day, and they reset at 12AM in GMT (UK Time). 

## Events
### OnMessage
#### Granting experience
Whenever a player messages, Miki grants experience based on a few factors including time of the message. If the message is sent swiftly after another, Miki won't grant any experience.

#### Checking for achievements
If a player messages something that is in relation to an achievement, the bot will grant the player the achievement. For the list of achievements, check them here [achievements](/guides/achievements) 
In addition, you can type `/achievements` to see what achievements you have. Furthermore, you can do `/achievements @user` or `/achievements [user Id]` to see other people's achievements.

Accounts module

### Achievement Achievements

🖍️ Underachiever - 3 achievements unlocked 
✏️ Achiever - 5 achievements unlocked 
🖋️ Overachiever - 12 achievements unlocked 
🖊️ Completionist - 25 achievements unlocked 

### Donator Achievements

💖 Donator - Use 1 Donator key 
💘 Supporter - Use 5 Donator keys 
💟 Sponsor - Use 25 Donator keys 

### Gambling Achievements

🍺 Celebrator - 100K Mekos won in a single lottery 
🍸 Absolute Madman - 10M Mekos won in a single lottery 
🍾 Instant Millionaire - 250M Mekos won in a single lottery 

### General Achievements

📝 Chef - create a `/pasta` 
⭐ Contributor - an achievement for the contributors 
🌟 Developer - an achievement for the developer 
😱 Don't Touch That! - use a command you don't have permissions for. 
📚 Informed - use the `/info` command 

### Level Achievements

🎟️ Novice - get level 3 in a server 
🎫 Intermediate - get level 5 in a server 
🏵 Experienced - get level 10 in a server 
🎗 Expert - get level 20 in a server 
🎖️ Sage - get level 30 in a server 
🏅 Master - get level 50 in a server 
💮 Legend - get level 100 in a server 
🌸 Epic - get level 150 in a server 

### Money Achievements

💵 Loaded - 10K+ Mekos 
💸 Rich - 50K+ Mekos 
💲 Minted - 125K+ Mekos 
🤑 Meko Millionaire - 1M+ Mekos 
🏦 Billionaire - 1B+ Mekos 

### Voting Achievements

📧 Helper - 1 vote for Miki on [Discord Bots](https://discordbots.org/bot/160105994217586689/vote) 
🗳️ Voter - 25 votes for Miki on [Discord Bots](https://discordbots.org/bot/160105994217586689/vote) 
🗃️ Elector - 200 votes for Miki on [Discord Bots](https://discordbots.org/bot/160105994217586689/vote) 

### Secret Achievements

😏 Lenny - say a secret phrase 
🍀 Lucky - very lucky 
🐸 o shit waddup! - say a secret phrase 
🚢 Shipgirl - say a secret phrase 
🎲 Unlucky - never lucky... 
💋 Pervert - Special achievement by doing a lot of nsfw commands. 
😭 Lonely - display loneliness by doing a certain action 

### Activity Achievements

🐟 Novice Fish Collector - Collect 5 different species of fish 
🐟 Seasoned Fish Collector - Collect 10 different species of fish 
🐟 Expect Fish Collector - Collect 20 different species of fish 
🐟 Master Fish Collector - Collect 40 different species of fish 

⛏️ Novice Rock Collector - Collect 5 different types of mineral 
⛏️ Seasoned Rock Collector - Collect 10 different types of mineral 
⛏️ Expect Rock Collector - Collect 20 different types of mineral 
⛏️ Master Rock Collector - Collect 40 different types of mineral 

### No Longer Obtainable

🛡️ Guardian - Reach the leaderboards.

Achievements module

Actions are basic functions to communicate with other players.

Command and Syntax | Description | Usage
----------------|--------------|-------
`/ask [context]`   | Ask someone something. | `/ask @Miki Can I have mekos?`, `/ask for mekos`
`/bite [something/someone]`  | Miki bites you or you bite someone/something. | `/bite`, `/bite an apple`, `/bite @Veld`
`/cake [something/someone]`  | Miki gives you cake or you give cake to someone/something. | `/cake`, `/cake chair`, `/cake @Fuzen`
`/cuddle [something/someone]`     | Miki cuddles with you or you cuddle with someone/something | `/cuddle`, `/cuddle teddy bear`, or `/cuddle @Veld`
`/glare [something/someone]`     | Miki glares at you or you glare at someone/something | `/glare`, `/glare at your friend`, or `/glare @Veld`
`/highfive [something/someone]`     | Miki highfives you or you highfive someone/something | `/highfive`, `/highfive bro`, or `/highfive @Veld`
`/hug [something/someone]`     | Miki hugs you or you hug someone/something | `/hug`, `/hug dad`, or `/hug @Veld`
`/kiss [something/someone]`     | Miki kisses you or you kiss someone/something | `/kiss`, `/kiss someone`, or `/kiss @Veld`
`/lick [something/someone]`		| Miki licks you or you lick someone/something | `/lick`, `/lick someone`, or `/lick @Veld`
`/pat [something/someone] or /pet [something/someone] `     | Miki pats you or you pat someone/something | `/pat`, `/pat doge`, or `/pat @Veld`
`/poke [something/someone]`     | Miki pokes you or you poke someone/something | `/poke`, `/poke your friend`, or `/poke @Veld`
`/punch [something/someone]`     | Miki punches you or you punch someone/something | `/punch`, `/punch doge`, or `/punch @Veld because he's a masochist`
`/slap [something/someone]`     | Miki slaps you or you slap someone/something | `/slap`, `/slap Charizard`, or `/slap @Veld`

Actions module

Command and Syntax | Description | Usage
----------------|--------------|-------
`/art safebooru <tags>` | Finds an anime image based on your tags. All images returned by /art will be safe for all ages (though some may show a lot of skin). Type `none` for no tags, or `-<tag>` to exclude a tag. | `/art safebooru kancolle`
`/art gelbooru <tags> <minimum-score>` | Returns an anime image from this website. You may choose a minimum score. | `/art gelbooru tags:1girl minimum-score:100`
`/art konachan <tags> <minimum-score>` | Returns an anime wallpaper from this website. You may choose a minimum score. | `/art konachan none`
`/art e621 <tags> <minimum-score>` | Returns a furry image from this website. You may choose a minimum score. | `/art e621 wolf`
`/anime search [term]` | Searches for anime based on term and displays a list of anime that have that term in their name.| `/anime find youkai`
`/anime searchcharacter [term]` | Searches for characters based on term and displays a list of characters that have that term in their name.| `/anime findcharacter Tomoe`
`/anime searchmanga [term]` | Searches for manga based on term and displays a list of manga that have that term in their name.| `/anime findmanga yuragi`
`/anime info [term]` | Searches for anime based on term and displays top result that have that term in their name.| `/anime get youkai`
`/anime characterinfo [term]` | Searches for characters based on term and displays top result that have that term in their name.| `/anime getcharacter Tomoe`
`/anime mangainfo [term]` | Searches for manga based on term and displays top result that have that term in their name.| `/anime getmanga yuragi`

Anime module

Donator-only commands

Command and Syntax | Description | Usage
----------------|--------------|-------
`/donator box <text> [@user/image attachment]` | Typical box meme | `/donator box Most Hated Admins @Rappy` 
`/donator disability [@user]` | Not all disabilities look like this... | `/donator disability` `/donator disability @Rappy`
`/donator redeemkey <key>` | Redeem a donator key | `/donator redeemkey a4832bh-a8s09f99a0-4928c76aec876ca`
`/donator sellkey <key>` | Sell a donator key for 30,000 mekos. Sometimes you have excess donator keys that you can't seem to get rid off. | `/donator sellkey a4832bh-a8s09f99a0-4928c76aec876ca`
`/donator tohru <text>` | Displays Tohru meme with text | `/donator tohru Whoever wrote the Miki wiki sucks`
`/donator trapcard [@user]` | Displays a yugioh meme with your avatar or someone else's | `/donator trapcard`, `trapcard @xRappy`
`/donator truth <text>` | Displays a New Game meme with some text | `/donator truth Miki best bot`

Donator module

Writer

## What are slash commands and how do they work?
Recently, Miki implemented slash commands, which is a new Discord feature for bots. Instead of using `>` before a command, you use `/`, and you'll get additional information about the command and its options! 
However, slash commands must be enabled in your server. To do this, go to Roles, select @everyone and make sure to enable the Use Slash Commands permission. You might also need to give this permission to Miki itself. 
If slash commands still don't work in your server, try kicking Miki and adding her back in.

## Is there a way to see all of Miki's commands? 
Type `/help` to see a list of command modules. Type `/help <command or category>` for specific command tips. Also, you can use this Wiki, though it might be slightly outdated.

## What are mekos?
Mekos are a form of currency for Miki. You can gain mekos by typing `/daily` and when your guild is beating its rival, you can use `/weekly`. Another source of mekos is from people giving them to you by typing `/give <User> <number>`. You can buy marriage slots with mekos by doing `/marriage buyslot` and saying `yes` to confirm. Also, you can gamble mekos with `/slots`, `/flip`, `/rps` and `/blackjack`.

## How can I turn off level up notifications?
Use the following command: `/setnotifications levelups setting:Disabled apply-to-all-channels:True` 
However, we recommend that you use `/notificationchannel` instead to set a specific channel for these notifications. Then, you may forbid Miki from sending messages in that channel if you like.

## How do I make Miki mention people in greetings?
Just use `-um` as a placeholder in your greeting message to mention the user when they join. 
Example: `/eventmessage welcome set message:-um, welcome to the server!` will yield `@User, welcome to the server!`.

## What are the achievements and how do I get them?
Achievements are given to the user when they accomplish a certain task such as using a specific command. 
You can find the list of achievements in the [Achievements module](../achievements/) tab of the wiki.

## How do I gain experience and levels? 
When a user sends a message, Miki grants experience based on a few factors. If the message is sent swiftly after another, Miki won't grant any experience. (No spamming, m'kay?)

## How do you disable a command?
In order to either disable or give access to a command, you need to go into your `Server Settings → Integrations → Miki` and choose a command. 
Make sure to update your desktop client in order to see this menu.

## Miki isn't responding, what can I do?
There are many possible reasons why Miki isn't "responding":
- Check if Miki has `Send Messages`, `Read Messages` and `Embed Links` permissions for the channel.
	- Note that channel permissions override (have priority over) role permissions.
- The prefix may have been changed and you can check by doing `miki.prefix` which will reveal Miki's current prefix.
	- `miki.` is Miki's hidden unchangeable prefix in case you forget your prefix.
- If these options don't work, it is recommended you go and ask in [our Discord support server](https://discord.gg/39Xpj7K).

## Miki is in my server but no commands are visible
Make sure that your server has the "Use Application Commands" permission and that Miki's commands are enabled

## How do I divorce someone when they're not in my server anymore?
Type `/divorce user:` to divorce a specific user. If the person you're looking for is no longer in the same server, you can first do `/divorce` to see the position of everyone that is married to you, then type `/divorce number:` and the position of who you want to divorce.

## The name on my profile isn't the same as my username; what do I do?
Use the `/syncname` to update your username to the database.

## Why are the NSFW commands not working?
First, NSFW commands only work on NSFW channels. A channel can be configured to be NSFW in its channel settings. 
Then, an administrator must enable NSFW commands by going into `Server Settings → Integrations → Miki → /nsfw`, and **choosing** a channel or role that has access to it (@everyone won't work). See the image for an example. (Make sure to update your desktop client in order to see the integrations menu) 
![nsfw example](https://media.discordapp.net/attachments/341250197252210689/973676105666031667/unknown.png) 
After this is done, the `/nsfw` command should appear. You will then also be able to use the non-slash version, for example `>nsfw gelbooru` 
For now, Discord requires us to place these limitations to protect our users.

Frequently asked questions

Fun is a module for small, playful commands.

Command and syntax | Description | Usage
----------------|--------------|-------
`/8ball [text]` | Stimulates an 8ball and gives an answer | `/8ball will I pass this test?`
`/bird` | Gives a random image of a bird | `/bird`
`/cage` | Cage command returns a random picture of Nicholas Cage. | `/cage`
`/cat` | Gives a random image of a cat | `/cat`
`/compliment` | Miki will compliment you | `/compliment`
`/dog` | Gives a random picture of a dog. | `/dog`
`/gif <tags>` | Searches for a gif on Imgur | `/gif slap`
`/greentext` | Gives a random greentext image | `/greentext`
`/img <tags>` | Searches for an image on Imgur | `/img Florestina`
`/lunch` | Woof! Woof! What's for lunch? | `/lunch`
`/pick <choice 1>, <choice 2>, [choice 3], ...` | Miki picks one of the choices randomly | `/pick IA, Gumi, Miki`
`/pun` | Gives a random pun | `/pun`
`/reddit <subreddit> [list]` | Shows reddit posts per subreddit | `/reddit dankmemes` 
`/reminder <action> in <time>` | Reminds you to do something in a certain amount of time. | `/reminder Do homework in 2 hours and 30 seconds`
`/reminder list` | Displays all your reminders and their codes | `/reminder list`
`/reminder clear <reminder code>` | Removes a reminder based on code. | `/reminder clear 993`
`/roll` | Returns a random number between 1 and 100)| `/roll`
`/roll [number]` | Returns a random number between 1 and that number | `/roll 60`
`/roll r[number]d[sides]` | Rolls number of dice of x number of sides | `/roll r2d3`
`/roll [spicy stuff]` | Do math | `roll r2d3+2` (returns 2 3-sided dice + 2 added to the final sum)
`/ship <user/mention>` |Ship yourself and show your compatibility rate with another user. | `/ship`, `/ship @Veld`, `/ship 102405515060994048`

Fun module

Gambling your mekos away.

`/slots <amount>` - gamble mekos to get more mekos. See **Slot Win Values** for win payouts. 
### Slot Win Values:
2 cherry = 50% return on bet 
3 cherry = Break even 
2 tangerines = 80% return on bet 
3 tangerines = 50% won 
2 strawberry = Break even 
3 strawberry = 100% won 
2 pineapples = Break even 
3 pineapple = 400% won 
2 grapes = 20% won 
3 grapes = 600% won 
2 watermelon = 50% won 
3 watermelon = 1,000% won 
2 stars = 200% won 
3 stars = 1,200% won 
Anything else: 0% won. You're just that bad.

`/blackjack <amount>` - Bet <amount> in a game of blackjack. 

`/flip <amount> <heads:tails> [-bonus]` - Bet <amount> in a brutal coin toss. `-bonus` is a "bonus" parameter. 

`/lottery view` - Displays the jackpot. 
`/lottery buy [amount of tickets to buy]` - Buy tickets and if you're chosen, you will win the jackpot. 

`/rps <amount> <rock:paper:scissors>` - Bet <amount> in a game of rock-paper-scissors.

Gambling module

Displays your profile for certain games.

Command and Syntax | Description | Usage
----------------|--------------|-------
`/osu standard <username>` | Gives Osu!standard stats based on username | `/osu standard NobodyEpic`
`/osu taiko <username>` | Gives Osu!taiko! stats based on username | `/osu taiko Veld`
`/osu ctb <username>` | Gives Osu!Catch the Beat! stats on a specific username | `/osu ctb Veld`
`/osu mania <username>` | Gives Osu!Mania! stats based on username | `/osu mania ZhePhan`

Gaming module

This module contains most of the commands, mainly those people that would like to have in every server belongs here.

Command and Syntax | Description | Usage
----------------|--------------|-------
`/avatar [User]` | Displays your avatar or the another user's avatar. | `/avatar`, `/avatar @xRappy`
`/calc <expression>` | Helps you calculate a certain mathematical expression | `/calc (6+2)*3`
`/changelog` 	| Shows what changed last Miki patch	| `/changelog`
`/donate` | Donate command will provide you donation info | `/donate`
`/help [command]` | Help command gives you list of modules along with its respective commands that you have permission to use. | `/help`
`/info` | Shows info about the bot| `/info`
`/invite` | Miki will Direct Message you a bot invitation link. |`/invite`
`/ping` | Shows Miki's ping to the server. | `/ping`
`/stats` | Displays statistics about Miki's runtime | `/stats`

General module

Guild-related commands.

Command and Syntax | Description | Usage
----------------|--------------|-------
`/weekly` | You get mekos for the week based on your guild's house. |`/weekly`
`/guild bank [arguments]` | Displays information for the guild bank. You can also deposit mekos to the guild bank. | `/guild bank deposit 1000000` `/guild bank balance`
`/guild config expneeded <value>` | Set local xp requirement in order to use `/guild weekly` | `/guild config expneeded 200`
`/guild config visible <yes/no>` | Set whether guild should be displayed in `/guild top` if possible | `/guild config visible yes`, `/guild config visible no`
`/guild house` | Displays what tier your guild is. | `/guild house`
`/guild profile` | Profile of your guild | `/guild profile`
`/guild upgrade` | Upgrade your guild to increase your `/weekly` multiplier. Consumes mekos from `/guild bank` | `/guild upgrade`

Guild accounts module

This module contains commands regarding welcome or leave messages for your server.

Command and Syntax | Description | Usage
----------------|--------------|-------
`/eventmessage leave set` | Sets a leaving message for that channel. | `/eventmessage leave set message:Rip, -u , just left the server!`
`/eventmessage welcome set` | Sets a welcome message for that channel. | `/eventmessage welcome set message:Welcome, -um , to the server!`
`/eventmessage welcome test` | Tests and displays what the welcome or leave message is for the channel the command is executed in. | `/eventmessage welcome test` `/eventmessage leave test`

##Variables 
`-u` = username 
`-um` = user mention 
`-o` = guild owner 
`-om` = guild owner mention 
`-g` = guild name 
`-c` = guild count

Logging module

Command and syntax | Description | Usage
----------------|--------------|-------
`/marriage buyslot` | Buy some extra marriage slots. | `/marriage buyslot`
`/marry <User>` | Propose to someone. | `/marry @HotGrill`
`/marriage showproposals` | Shows who you proposed to and who you're getting proposed by. | `/marriage showproposals`
`/marriage accept <User>` | Accept a `/marry` proposal if you find your dream partner :^) | `/marriage accept @HotGrill`
`/marriage decline <number>` | Be savage and decline a `/marry` proposal. | `/marriage decline 1`
`/marriage cancel <number>` | Cancel a proposal you sent to someone | `/marriage cancel 1`
`/divorce <number>` | When you don't like the person you are married to, you can always divorce :^). Type the number for the person in the list that you want to divorce. | `/divorce 3`

Marriage Module

Commands regarding Miki's copypasta system.

Command and Syntax | Description | Usage
----------------|--------------|-------
`/pasta create <title> <content>` | Makes a copypasta. | `/pasta create "Veld" Best developer ever :smirk: `
`/pasta delete <name of pasta>` | Have you ever create an embarrassing pasta? Simply use this command to delete it. | `/pasta delete MyFacebookPassword`
`/pasta edit <name of pasta> <content>` | Have you ever misspell something while writing your own pasta? Simply use this command to edit it. | `/pasta edit MyFacebookPassword **********`
`/pasta hate <name of pasta>` | Downvote a pasta. | `/pasta hate memes`
`/pasta listhated <name of pasta>` | List of your downvoted pastas. | `/pasta listhated`
`/pasta info <name of pasta>` | Have you ever want to check out who created that cool pasta? :dark_sunglasses: Some pastas might be untrackable because of an accidental reset or how old the pasta is.| `/pasta info PastaCommands`
`/pasta love <name of pasta>` | Upvote a pasta. | `/pasta love VeldSugarDaddy`
`/pasta listloved <name of pasta>` | List of your upvoted pastas. | `/pasta listloved`
`/pasta mypasta <page>` | Lists the pastas you created. | `/pasta mypasta`
`/pasta <name>` | Uses a copypasta. | `/pasta haha`
`/pasta search <keyword>` | Searches a copypasta from the database. | `/searchpasta dank_meme`

Pastas module

Reactions is a module that shows you a picture of an anime girl doing some emotion ( ͡° ͜ʖ ͡°) .

Command and syntax | Description | Usage
----------------|--------------|-------
`/confused`  | [LOUD CONFUSION] | `/confused`
`/cry` | It do be like that sometimes... | `/cry`
`/lewd` | There's not much of an explanation for this command. | `/lewd`
`/pout`  | My disappointment is immeasurable and my day is ruined. | `/pout`
`/smug`  | It's okay to flex sometimes. | `/smug`
`/stare` | Jiiiiiii...  | `/stare`

Reactions module

Command and syntax | Description | Usage
----------------|--------------|-------
`/listlocale` | Shows list of supported languages | `/locale list`
`/locale set <language>` | Set language of the bot to your preference. **Work In Progress - Untranslated strings default to English**. | `/locale set spanish`
`/setnotifications <levelups/achievements> <All/Disabled/RewardsOnly> <apply-to-all-channels>` | Allows you to configure notifications for your guild.| `/setnotifications levelups setting:Disabled apply-to-all-channels:True`, `/setnotifications achievements setting:All`
`/notificationchannel set` | Send all notifications to a single channel. | `/notificationchannel set #spam`
`/prefix set <prefix>` | Set command prefix to the <prefix> | `/prefix set --`

Settings Module

Zephy

Editor

When using Miki you will frequently come across the word 'mekos' being used, mekos are the currency used throughout Miki's economy and can be gained and spent in many different ways. In this guide we will be taking a look at:

- How mekos can be gained
- Gambling with mekos
- How mekos can be spent

 

## How can mekos be gained?

There are several ways to gain mekos through Miki's commands, here are all the recommended methods:

#### Daily Command

Daily (`/daily`) can be used every 24 hours to gain mekos. The base amount of mekos gained through daily is 100, however this will increase by 20 for every consecutive day that you claim your daily. If 48 hours pass since your last daily claim, your streak will end and your daily will reset back to 100 mekos. Donators receive a doubled amount from each daily, meaning they will begin by gaining 200 mekos which will increase by 40 mekos for each consecutive day claimed.

The maximum amount you can gain from a daily streak is 2,100 mekos per day (4,200 for Donators), this is achieved after accumulating a streak of 100 days. Additionally, you can also claim your daily on this website by going to your [claim daily](/profiles/me/daily) page.

#### Weekly Command

Weekly (`/weekly`) can be used once per week per server. The amount gained from weekly is dependant on the level of the server's guild and the tier of guild house the guild currently has. The current guild house level and weekly multiplier can be viewed using `/guild house`, this will also display the cost of upgrading the guild house to the next tier. The guild house can be upgraded using `/guild upgrade`, upgrading the guild house will increase the weekly multiplier, however only people with the `Manage Server` permission can upgrade this. To upgrade the guild house the guild bank must contain enough mekos, you can view the amount of mekos in the guild bank using `/guild bank balance` and deposit mekos into the guild bank using `/guild bank deposit [number]`.

#### Working

There are several jobs that you can do in Miki such as mining and fishing. Each job require you to buy some tools from the `/shop`, but will pay off the more you master it. use `/fish` or `/mine` to start and play a small minigame.

#### Voting on top.gg

Another way to gain mekos is to vote for Miki on Top.gg. You can vote for the bot every 12 hours. After voting you will receive a direct message from Miki stating the amount of mekos you have received for voting.

The base amount of mekos gained from voting is 100, this increases by 100 mekos for each consecutive day of voting up to a maximum of 10,000 mekos per vote after obtaining a 100 day streak. Failing to vote for 24 hours will end the streak.

Donators will receive double the amount from voting, this means they will begin by gaining 200 mekos, which will increase by 200 for each consecutive vote up to a maximum of 20,000 per vote. A link to the top.gg website can be found by using the `/donate` command.

## How can I gamble with my mekos?

There are a variety of different games you can play to gamble with your mekos, the following are the gambling commands currently available:

| Commands | Description | Max Bet | Payout |
| -------------------------------------------------------------------------- | -------------------------------------------------------------- | --------- | -------------------- |
| `/blackjack new [Bet_Amount] ok` `/bj new [Bet_Amount] ok` | Play against Miki in a game of blackjack! | 1,000,000 | Double your bet |
| `/slots [Bet_Amount]` `/s [Bet_Amount]` | Try your luck on the slot machine! | 99,999 | Dependant on Payline |
| `/flip [Bet_Amount] [tails/heads]` `/flip [Bet_Amount] [t/h]` | Flip a coin, guess the correct side to win. | 10,000 | Double your bet |
| `/rps [Bet_Amount] [rock/paper/scissors]` `/rps [Bet_Amount] [r/p/s]` | Play a game of Rock Paper Scissors. | 10,000 | Double your bet |
| `/connect4 [Bet Amount] [Opponent?]` | Play a game of Connect 4 against your friends or against Miki! | 10,000 | Double your bet |

## What can mekos be spent on?

#### Experience card customisation

There are 38 different backgrounds you can purchase with mekos, these backgrounds can be applied to your experience card, which is viewed using the `/exp` command. Using `/background buy [number]` will display the chosen background along with its price, this will not actually purchase the background unless the purchase is confirmed. You can check your owned backgrounds using `/background list` and apply a background to your experience card using `/background set [number]`.

#### Purchasing roles

- Using Miki, it is possible for servers to set up roles to be obtainable by purchasing them with mekos, you can see a list of all the roles a server has available using `/iamlist [page_number]`.
- A role that costs mekos will display with a orange diamond emoji along with the cost. You can purchase the role using `/iam [role_name]`.
- An in-depth guide on setting up purchasable and other kinds of roles for your server can be found [here](https://miki.bot/guides/using-miki-role-configuration)

#### Marriage slots

Marriage slots can be purchased with mekos. You will begin with 5 slots and can purchase 5 more for a maximum of 10 while Donators can purchase an extra 5 slots on top of this for a maximum of 15. Purchasing your first slot will cost 2,500 mekos, however with each slot purchased the price will increase linearly by 2,500 mekos per extra slot.

#### Guild Bank

Mekos can be donated to a server's guild bank using `/guild bank deposit [number]` and the guild can use these mekos to upgrade their guild house to increase their `/weekly` multiplier. You are not able to withdraw mekos from the guild bank once they have been deposited.

#### Giving to others

- You can give mekos to other users using `/give [@user] [amount]`

Interested in becoming a donator and gaining all the great perks that come along with it? You can obtain premium by clicking [here](/premium).

We hope this guide has been helpful! If you have any further questions regarding any of Miki's features you can visit the [Miki Support server](https://discord.gg/39Xpj7K), where our support staff would be glad to assist you!

Miki's currency and its uses

Advocatus


Miki is such a diverse bot and with diversity comes different languages. Localization, changing something to be more like your local area such as language, allows the diverse users of Miki to enjoy her services in 26 languages! With the help of the community of users, this has been made possible. The languages available are: Arabic, Bulgarian, Czech, Danish, Dutch, English, Finnish, French, German, Hebrew, Hindi, Hungarian, Italian, Japanese, Lithuanian, Malaysian, Norwegian, Polish, Portuguese, Russian, Estonian, Swedish, Tagalog, Ukranian, Chinese Simplified, Chinese Traditional.

There’s two really important things to know about Miki’s language feature before you dive into it and explore the options it has to offer. Firstly, while anyone on the server can view the language options available, only those with permission to can actually change the language that Miki will operate in. Secondly, the languages are translated with a team of volunteers, and not all languages are completely done , this means you might come across some text that is still in the English language despite selecting a different one for Miki.

With that out of the way, it’s not expected for you to be able to always remember the languages that Miki can serve you in. After all, there could be new languages added over time that you might not even know about! A language is referred to as [locale] for Miki and anyone can see the listing of the locales available. Simply utilize the `/locale list` command and Miki will display the languages available, as shown below.

![](/images/localization/language-1.png)

Any of those languages are selectable by Miki and she will operate in that language for you as much as possible. Once the decision has been made for which language she will work in, there’s a simple command to implement the change. The command is `/locale set` and simply typing the name of the language you wish to select for the channel you are using. This means you can have a Miki using different languages in different channels. The command looks like so:

![](/images/localization/language-2.png)

Just like so, and now Miki will operate in Hungarian to the fullest capacity possible. As an example, let’s try to marry someone.

![](/images/localization/language-3.png)

It looks like we are already married to this user and Miki has informed us of the mistake in Hungarian. Perfect! Miki is saying everything possible in Hungarian, just like we told her to do! But, as you can see, the actual name of the Miki command is always in English.

If you’re interested in helping translate Miki further in the languages available, or wish to expand her horizons with new languages for her, please feel free to join the translation volunteer team. The link to the translation website is: [here](https://poeditor.com/join/project/FIv7NBIReD) and to join the official Miki Translation team discussion channel and for a special Translator role, please join the [Miki Support server](https://discord.gg/39Xpj7K) and contact a member of the server staff.


How to use Miki in your language


Miki now uses Discord's own command permission system. First, make sure your desktop client is updated to the latest version. Then, go into your `Server Settings → Integrations → Miki`. It should look like this:

![permissions](/images/permissions/integrations.png)

You may then select the roles, users and channels that have access to each individual command, or the whole bot.

Please note that some commands are restricted by default, but Discord will still show it is available for everyone / all channels.  
For example, `/setnotifications` requires the user to have the Manage Server permission by default. It will appear as though everyone can use it, but they won't be able to, for your protection. You can override this behavior by setting your own restrictions, and the command will then work as expected.  


Miki’s permission system

Gerard

# MiScript
MiScript is Miki's custom command language, specifically written to make easy-to-use custom commands for your own server. 
Not only are Miki's custom commands powerful, but they will also become real slash commands in your server, and will appear when you type `/`. 
In this guide, we will show you how to get started with MiScript. 

## Commands
| Commands | Description |
| --------------------------------------------- | ------------------------------------------------------------- |
| /customcommand create [command name] [script] | Used to create a custom command |
| /customcommand remove [command name] | Used to delete an existing custom command |
| /customcommand get [command name] | Used to get the code of an existing custom command |
| /customcommand getstorage| Used to see the storage of custom commands |
| /customcommand list | Used to see all custom commands in your server |
| /customcommand sync | Used when something is wrong with your custom slash commands.|
| /customcommand setdescription [command name] [description] | Used to set a description for your custom slash command. |

## Your first script
```miscript
say("hello world!")
```
As you may have realized, this command simply makes Miki say "hello world". There's nothing else happening. You may add it to your server like this:

`/customcommand create command-name:helloworld command-script:say("hello world!")`

### Variables
Variables let you store a value, and then use it later. You define them with `var` and give it any name you want. For example:

```miscript
var mynumber = 5
mynumber = mynumber * 2
say(mynumber)
```
This will create a variable called `mynumber` with a value of 5. It will then multiply it by 2 and send it:
```
10
```

## Message values 
You can add a value to your text by putting it inside `$[]`. For example:
```
say("The number is $[mynumber]")
``` 
Also, Miki will provide a few global variables you can use, such as `author`, `guild`, `channel` and `message`. These have information about how the command was used. Consider this example:
```miscript
say("Hello $[author]")
```
If the user Veld used this command, it would send:
```
Hello Veld
```

## Conditionals
You are able to send different responses under different conditions. For example:
```miscript
if author = "Veld" then
 say("Hello Veld!")
else
 say("Wait, you're not Veld!")
end
```

## Arguments
The person using your command may include additional information. This is accessible through the global variable `args`.

Imagine we have a command `/age`, and its code is as follows:
```miscript
say("You are $[args] years old")
```
If your user types `/age 20`, Miki will say
```You are 20 years old```
However, if the user doesn't enter any args, its value will be empty. You may want to check like this:
```miscript
if args.length == 0 then
 say("No args!")
else
 say(args)
end
```
The length in this case is the amount of arguments (which were separated by spaces), as `args` is in fact a list. More on lists later.

## Embeds
It is also possible to send embeds with MiScript. You may even use them in `/levelupmessage`. For example: 
```miscript
say(embed("Probably because you said something weird...")
 .title("$[author.name] ignores you")
 .image("https://media.giphy.com/media/H9jrEhsr1pUMo/giphy.gif"))
```
This would show:

![image](https://i.imgur.com/zzQGqFT.png)

There are more functions like `.footer("Text")` and `.color("red")` for the embed builder; check out the [API reference for embeds](#embed).

## Adding your command
In the "hello world" example, you saw how to add a command with a script to your server. However, sometimes your command consists of multiple lines, which currently can't be sent properly in a Discord slash command. In this case, you may chain lines together, and use `;` between each statement. Or you may use the non-slash command, like this:

![image](https://cdn.discordapp.com/attachments/341250197252210689/976280961069248542/unknown.png)

Notice the dark background behind the code. This is a **code block**, and you may use it by putting triple backticks \`\`\` at the start and end of your code. It is optional, but it makes it look more organized.

## Removing commands
To remove an existing command, you can use ```/customcommand remove [command name]```. For example, if you want to remove the command we created above, you would use ```/customcommand remove orchid```.

&nbsp;

# ⚠ Programming Alert:
The following sections will go in depth on what MiScript can do. This can be overwhelming when you're new to programming.
If you need help, feel free to join our [Discord Server](https://discord.gg/39Xpj7K) and ask for help in the #miscript channel.

## Functions
When you want to execute code multiple times, you can create a function.

### Creating functions
The following code creates a function in MiScript:

```miscript
fun greet(name)
 say("Hello $[name]!")
end
```

Let's go through this script: 

| Code | Description |
| ---- | ------------|
| `fun` | Tell MiScript that we'll create a new function. |
| `greet` | Function name. Use this name to call the function. |
| `(name)` | Arguments that the function takes. |
| `say("Hello $[name]!")` | The body of the function. This will be executed when the function is called. |
| `end` | End of the function |

Now that we defined the function "greet", we can call it:
```miscript
greet("Veld")
```
This will return:
```
Hello Veld
```

### Loops
Using functions, we can run code many times without having to copy and paste it. There is no "loop" statement in MiScript, but you may `.map` over a range of numbers or a list of values. For example:
```
(1..10).map(fun(e)
 say("I have said this $[e] times")
end)
```

### Arrow functions
Sometimes you don't want to define a whole function, just run a single line of code. This is possible with arrow functions. 
Consider this example that takes a list of strings (text), and then converts every value into uppercase:
```miscript
["hello", "miki"].map(e => e.upper())
```
Let's go through the arrow function: 

| Code | Description |
| ---- | ------------|
| `e` | The parameter of the function. For more than one parameter, you can do `(param1, param2)` |
| `=>` | Tell MiScript we're creating an arrow function. |
| `e.upper()` | The body of the function, which is being directly returned. In this case, `.upper()` will uppercase every character.|

When you execute the code, the result will be: `["HELLO", "MIKI"]`. You will have to use `say` to send it though.

## Lists
Lists are used to store multiple values in a single variable. Normally, you would try to do this:
```miscript
var user1 = "Veld"
var user2 = "Gerard"
var user3 = "Zephy"

say("Cool dudes: $[user1], $[user2], $[user3]")
```
You can see how the amount of variables will pile up if we add more users, and there is no easy way to get all the users at once. The solution is to use a list.

A list starts with `[` and ends with `]`. So an empty list would be `[]`. 
To create an list with a string, you place the string between the brackets: `[ "value" ]`. 
To add multiple strings, you add them separated with commas within the brackets: `[ "Veld", "Gerard", "Zephy"]`.

There are several useful functions for lists, such as `.map()` which we saw before. 
We can join these users together with `.join()`:
```miscript
var users = ["Veld", "Gerard", "Zephy"]

say("Cool dudes: $[users.join(", ")]")
```
This will return:
```
Cool dudes: Veld, Gerard, Zephy
```
For more list functions check out the [API reference for list](#List).


## Stop sequence
Since there is a message limit on Discord, using `if` and `else` over and over again is not a good idea for bigger commands. Using `stop` will stop the script and won't execute the rest of the code.
```miscript
say("This message will be shown!")
stop
say("However, this message will be ignored!")
```

## Storage API
When a script is finished, all the variables you have defined will be lost. To save a value, you can use the storage API.

⚠ **Warning:** The storage API is not infallible; it's rarely possible that your data will be lost. We will work to prevent this from happening.

Let's create a command that remembers how many times the command was executed. First, decide a unique key that you'll use in the storage, in this example we'll be using `"count"`.

To store a value in the storage, you can use `storage.set()`.
```miscript
storage.set("count", 1)
```
To retrieve a value from the storage, you can use `storage.get()`. 
When a key doesn't exist in the storage, the result will be null.
```miscript
var count = storage.get("count")
```

### Example
Let's make a command that counts how many times it was executed.

First, we retrieve the value from the storage because it's possible that the command was executed before. When it doesn't exist, we set the count to 0.
```miscript
var count = storage.get("count")

if not count then
 count = 0
end
```
Now we increment the value by 1, store it back to the storage and say the result:
```miscript
count = count + 1
storage.set("count", count)

say("Count: $[count]")
```
When executing the command multiple times, you'll see that the counter increases:

![image](https://i.imgur.com/3YqGcIH.png)

### View storage
To see what data is stored in the storage, you can use the command `/customcommand getstorage`:

![image](https://i.imgur.com/Sih9z2g.png)

### Limits
To prevent abuse of the storage API, it has a key and value limit. To increase the amount of data, The owner of the Discord Server (where the command is being executed) can [donate](/donate) to get additional keys.

| | Default | Donator |
|--------------------|------------|------------|
| Amount of keys | 1 | 25 |
| Maximum value size | 4 KB | 4 KB |

&nbsp;

## API Reference
The following section covers what the API can do in MiScript.

### Globals
| Function | Description |
| ------------------- | ------------|
| `args` | List with the arguments for the current message. **Message**: `/command test` **Result**: `["test"]`|
| `message` | Current message. See [Message](#message) for more information. |
| `author` | Author of the message. See [User](#user) for more information. |
| `guild` | Current guild. See [Guild](#guild) for more information. |
| `channel` | Channel where the message was sent. See [Channel](#channel) for more information. |
| `storage` | Storage API. See [Storage](#storage) for more information. |
| `embed()` | Create a new embed. See [Embed](#embed) for more information. |
| `say(content)` | Send a message or embed. **Example**: `say(embed("Hello world"))` |

### Message
| Function | Description |
| ------------------- | ------------|
| `id` | Discord message ID. **Example**: `message.id` **Result**: `322845087467962368`|
| `content` | Content of the message. **Example**: `message.content` **Result**: `"Hello!"`|

### Guild
| Function | Description |
| ------------------- | ------------|
| `id` | Discord guild ID. **Example**: `guild.id` **Result**: `160067691783127041` |
| `members` | Amount of members in the guild. **Example**: `guild.members` **Result**: `1337` |
| `icon` | Icon of the server. **Example**: `guild.icon` **Result**: `"https://cdn.discordapp.com/icons/..."` |
| `owner` | Owner of the server. See [User](#user) for more information. |

### Channel
| Function | Description |
| ------------------- | ------------|
| `id` | Discord channel ID. **Example**: `channel.id` **Result**: `160105994217586689`|
| `name` | Name of the channel. **Example**: `channel.name` **Result**: `"general"`|
| `nsfw` | True if the channel is NSFW. **Example**: `channel.nsfw` **Result**: `false`|

### User
| Function | Description |
| ------------------- | ------------|
| `id` | Discord user ID. **Example**: `user.id` **Result**: `160067691783127041`|
| `bot` | True if the user is a bot. **Example**: `user.bot` **Result**: `false`|
| `mention` | Create a mention to the user. **Example**: `user.mention` **Result**: `"<@160105994217586689>"`|
| `discrim` | Discriminator of the user. **Example**: `user.discrim` **Result**: `"6045"`|
| `name` | Name of the user. **Example**: `user.name` **Result**: `"Miki"`|

### String
| Function | Description |
| ------------------- | ------------|
| `.length` | Length of the string. **Example**: `"miki".length` **Result**: `4`|
| `.upper()` | Converts a string to uppercase letters. **Example**: `"miki".upper()` **Result**: `"MIKI"`|
| `.lower()` | Converts a string to lowercase letters. **Example**: `"MIKI".lower()` **Result**: `"miki"`|
| `.has(str)` | Check if the string contains a substring. **Example**: `"Hello Miki".has("Miki")` **Result**: `true`|
| `.startsWith(str)` | Check if the string starts with a substring. **Example**: `"Hello Miki".startsWith("Hello")` **Result**: `true`|
| `.endsWith(str)` | Check if the string ends with a substring. **Example**: `"Hello Miki".endsWith("Miki")` **Result**: `true`|
| `.replace(old, new)` | Replace every occurence of the old string with the new string. **Example**: `"Hello Beld".replace("Beld", "Veld")` **Result**: `"Hello Veld"`|
| `.trim()` | Remove every whitespace character at the begin and end of the string. **Example**: `" Hello Miki ".trim()` **Result**: `"Hello Miki"`|
| `.split()` | Splits the string into an list of substrings using every whitespace character. **Example**: `"hello world".split()` **Result**: `["hello", "world"]`|
| `.split(seperator)` | Splits the string into an alistrray of substrings using the given seperator. **Example**: `"hello-world".split("-")` **Result**: `["hello", "world"]`|
| `.indexOf(str)` | Get the position of the substring in the string. **Example**: `"Hello Miki".indexOf("Miki")` **Result**: `6`|
| `.remove(index, length)` | Remove a range in the string. **Example**: `"Hello Miki".remove(0, 6)` **Result**: `"Miki"`|

### Number
| Function | Description |
| ------------------- | ------------|
| `.toFixed(length)` | Converts the number into a string with the fixed amount of decimals. **Example**: `(1.23456).toFixed(2)` **Result**: `"1.23"`|

### List
| Function | Description |
| ------------------- | ------------|
| `.length` | Amount of items in the list. **Example**: `["hello", "world"].length` **Result**: `2`|
| `.has(item)` | Check if the list contains the item. **Example**: `["hello", "world"].has("hello")` **Result**: `true`|
| `.add(item)` | Add a new item to the list. **Example**: `["hello"].add("world")` **Result**: `["hello", "world"]`|
| `.del(item)` | Removes am item from the list. **Example**: `["hello", "world"].del("world")` **Result**: `["hello"]`|
| `.join(seperator)` | Combine all the values into a single string with a separator. **Example**: `["hello", "world"].join(" ")` **Result**: `"hello world"`|
| `.map(function) ` | Create a new list and map all the values by calling the function. **Example**: `["hello", "world"].map(i => i.upper())` **Result**: `["HELLO", "WORLD"]`|
| `.filter(function)` | Create a new list and add the values that pass the function filter. **Example**: `["hello", "world"].filter(i => i = "hello")` **Result**: `["hello"]`|
| `.take(amount)` | Create a new list and insert the first X amount of values. **Example**: `["hello", "world"].take(1)` **Result**: `["hello"]`|
| `.skip(amount)` | Create a new list and remove the first X amount of values. **Example**: `["hello", "world"].skip(1)` **Result**: `["world"]`|
| `.reverse()` | Create a new list and reverse the order of the items. **Example**: `["hello", "world"].reverse()` **Result**: `["world", "hello"]`|
| `.random()` | Get a random value from the list. **Example**: `["hello", "world"].random()` **Result**: `"hello"` or `"world"`|

### Object
| Function | Description |
| ---------| ------------|
| `.keys` | All the keys in the object. **Example**: `{name: "Miki", discrim: "6045"}.keys` **Result**: `["name", "discrim"]`|
| `.values` | All the values in the object. **Example**: `{name: "Miki", discrim: "6045"}.values` **Result**: `["Miki", "6045"]`|
| `.has(key)` | True if the key exists in the object. **Example**: `{name: "Miki", discrim: "6045"}.has("name")` **Result**: `true`|
| `.del(key)` | Removes the key from the object. **Example**: `{name: "Miki", discrim: "6045"}.del("name")` **Result**: `{discrim: "6045"}`|

### Range
| Function | Description |
| ------------------- | ------------|
| `.from` | Start position of the range. **Example**: `(1..10).from` **Result**: `1`|
| `.to` | End position of the range. **Example**: `(1..10).to` **Result**: `10`|
| `.toArray()` | Create an list with every number in the range. **Example**: `(1..10).toArray()` **Result**: `[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]`|
| `.random()` | Get a random number from the range. **Example**: `(1..10).random()` **Result**: A number between `1` and `10`|
| `.map(function) ` | Create a new list and map every number in the range. **Example**: `(1..10).map(i => i.upper())` **Result**: `["HELLO", "WORLD"]`|

### Function
| Function | Description |
| ---------| ------------|
| `.name` | Get the function name. **Example**: `(fun test() end).name` **Result**: `"test"`|

### Embed
| Function | Description |
| ---------| ------------|
| `.title(value)` | Sets the title of the embed. **Example**: `embed().title("New title")`|
| `.image(url)` | Sets the image of the embed. **Example**: `embed().image("https://media.giphy.com/media/H9jrEhsr1pUMo/giphy.gif")`|
| `.color(value)` | Sets the color of the embed. The value can either be a hex color (`#FFFFFF`) or a HTML color (`red`). **Example**: `embed().color("red")` |
| `.author(name, image, url)` | Sets the author of the embed. The image and url parameters are optional. **Example**: `embed().author("Miki")`|
| `.footer(content, url)` | Sets the footer content of the embed. The url parameter is optional. **Example**: `embed().footer("Miki")`|
| `.field(title, content)` | Adds a new field to the embed. **Example**: `embed().field("Title", "Content")`|
| `.inlineField(tile, content)` | Adds a new inline field to the embed. **Example**: `embed().inlineField("Title", "Content")`|

### Storage
| Function | Description |
| ---------| ------------|
| `.keys` | All the keys in the storage. **Example**: `storage.keys` **Result**: `["name"]`|
| `.set(key, value)` | Changes the value in the storage. **Example**: `storage.set("name", "Miki")`|
| `.get(key)` | Gets the value from the storage. **Example**: `storage.get("name")` **Result**: `"Miki"`|
| `.del(key)` | Remove the value from the storage. **Example**: `storage.del("name")`|
| `.clear()` | Clears the storage. **Example**: `storage.clear()`|

Using MiScript to create custom commands

So, looking to configure some roles in your server? Great! This guide will explain each command involved in configuring and obtaining roles using Miki, as well as go through some Discord features such as setting up permissions within your server. After reading this, you will have the necessary knowledge to set up a variety of different role configurations and know how to opt in or out of available roles. Before we start; make sure you already have Miki in your Discord server if you’d like to follow along and try things out for yourself!

## In this guide we will be showing you

- How the role commands work
- How to prepare your server for role management
- How to use arguments to configure roles

## Role commands

Before we get into configuring roles, let’s take a look at all of the commands you’ll need to know beforehand!

| Commands | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| /roleconfig `[role]` `[arguments]` | Used to configure roles and set their requirements, can only be used by people with permission to manage roles. Role names made up of multiple words must be surrounded with quotation marks |
| /iamlist `[page_number]` | Will display a list of roles obtainable using /iam `[role_name]` as well as their requirements <ul><li></i/Minimum level required</li><li> Role required</li><li> Cost of role in Mekos</li></ul> |
| /iam `[role]` | will allow you to **opt in** to an optable role, giving you the role. This will only work if you meet the requirements of the role. |
| /iamnot `[role]` | will allow you to **opt out** of an optable role that you have already obtained, removing the role from you. |

## Example of Command Usage

To configure a role, use the /roleconfig slash command. See below for options.

Once the role is configured as optable, it will appear on the /iamlist with its requirement displayed in the form of emotes.

![](https://cdn.miki.bot/web/landing/guides/using-role-config-2.png)
 
_This role displays no emotes because it has no requirements._

Now that the role is optable, it can be gained using /iam `[role_name]`

<div class="columns">
 <div class="column">
 <img class="image" src="https://cdn.miki.bot/web/landing/guides/using-role-config-3.png"/>
 </div>
 <div class="column">
 <img class="image is-rounded" src="https://cdn.miki.bot/web/landing/guides/using-role-config-4.png"/>
 </div>
</div>

To opt out of the role, use /iamnot `[role_name]`

<div class="columns">
 <div class="column">
 <img class="image" src="https://cdn.miki.bot/web/landing/guides/using-role-config-5.png"/>
 </div>
 <div class="column">
 <img class="image is-rounded" src="https://cdn.miki.bot/web/landing/guides/using-role-config-6.png"/>
 </div>
</div>

## Preparing your server

Before a role can be configured, it needs to be created first. To create roles within your server you have to navigate to the role tab within the server settings, here you will be able to create new roles and edit any existing roles.

<img class="image" src="https://cdn.miki.bot/web/landing/guides/using-role-config-10.png"/>
<img class="image" src="https://cdn.miki.bot/web/landing/guides/using-role-config-11.png"/>
<img class="image" src="https://cdn.miki.bot/web/landing/guides/using-role-config-12.png"/>

## Permissions

### What are permissions

Permissions are used within a discord server to give members or bots access to certain features. permissions are given to people through roles, each role can have a different set of permissions, however if a user has multiple roles their permissions will be inherited from their highest role.

Miki needs the "Manage Roles" permission in order to access the Discord servers roles. You can give Miki access to this permission by navigating to Miki’s role in server settings and enabling 'Manage Roles'.

![](https://cdn.miki.bot/web/landing/guides/using-role-config-13.png)

The 'Manage Roles' permission will only give Miki authority to manage roles underneath her role in the role hierarchy, therefore any roles you intend to configure will need to be below her role, you can drag roles up or down the hierarchy to change their position.

## Configuration

Now you're ready to configure some roles! Let's take a look at the commands associated with role management and the different arguments available to use when configuring roles.

### Arguments

There are multiple ways you can configure a role, each of these arguments will change the way the role is obtained by your members.
![](https://media.discordapp.net/attachments/341250197252210689/922307903342407730/unknown.png)
 
## Recommended ways to use Miki’s role system

Even though you’re completely free to use Miki and her role system; we would like to give you some inspiration of what you can do with these role configurations!

### Roles for level ups

This role configuration will make it so that whenever a user reaches **level 5** on your Discord server, they will get the specific role! This can be used to reward users that are being active, and whenever they level up to the required level, Miki will automatically give this role to the user.

There’s two different arguments you need: **Automatic** and **Level-Required**.

- **Automatic** is needed so that when your discord members are level 5, they will automatically get the role!
- **Level-Required** is needed to lock away the role from people below level 5. It would be unfair if anyone could just get it without being level 5.

To create this role use the following command.

```bash
/configrole role:@role automatic:true levelrequired:5
```

![](https://cdn.miki.bot/web/landing/guides/using-role-config-7.png)

### Optable roles

This is a very common, and easy way to freely create roles that can be obtained by anyone. This is super easy to use for roles such as hobbies, colours, and similar kinds of roles.

What Optable does is allow people to use this role in /iam and /iamnot, and they will appear in the /iamlist. This is mostly for commands that people should be free to take or not, whichever they want.

To create this role use the following command.

```bash
/configrole role:@role optable:true
```

![](https://cdn.miki.bot/web/landing/guides/using-role-config-8.png)

### Twitch subscriber roles

If you’re a creator on Twitch, Patreon, etc. Miki can allow your supporters to have special roles. This can be super convenient, because on occasion you might want to have users have extra rewards on your server, but still have them pick between different ones.

For example, you can have default colours which your Discord members can freely choose, and then for supporters; you can have prettier, hand-picked colours, to let them brag in the chat.

There’s two different arguments you need: **Optable** and **Role-Required**.

- **Optable** allows people to use this role in `/iam` and `/iamnot`, and they will appear in the /iamlist. This is mostly for commands that people should be free to take or not, whichever they want.
- **Role-Required** is used to have another role be a requirement before users can opt-in to this role. This can be any role in your Discord server.

To create this role use the following command.

```bash
/configrole role:@role optable:true rolerequired:@Twitch Subscriber
```

![](https://cdn.miki.bot/web/landing/guides/using-role-config-9.png)

We hope this guide has helped you use Miki’s role system to set up some roles for you and your members to use! Still have some questions? Why not join our discord server, we have an amazing community of Miki users to meet and our staff would be happy to answer any questions!

Using Miki’s role management commands in your server!

Collect cards, trade them, and show off your collection

Ask questions, get help, and make a new AI friend

Trade, earn, gamble, and spend your money

Form relationships, Get married, Spend time together

Learn about Miki through our tutorials

Configure Miki your way!

Dead chats? Not anymore!

Help your members find a goal

The best role manager ever made

Let Miki help you build your community by providing currency, games, levels, and rewards!

The Only Bot You'll Ever Need

Install {application} in your Discord Server!

Get all the features Miki provides instantly and grow your server

Level up your Discord Server today

See for yourself what communities have to say about Miki and her features

People love Miki!

<table>
<thead>
<tr>
<th>Command and syntax</th>
<th>Description</th>
<th>Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>/listlocale</code></td>
<td>Shows list of supported languages</td>
<td><code>/locale list</code></td>
</tr>
<tr>
<td><code>/locale set &#x3C;language></code></td>
<td>Set language of the bot to your preference. Work In Progress - Untranslated strings default to English.</td>
<td><code>/locale set spanish</code></td>
</tr>
<tr>
<td><code>/setnotifications &#x3C;levelups/achievements> &#x3C;All/Disabled/RewardsOnly> &#x3C;apply-to-all-channels></code></td>
<td>Allows you to configure notifications for your guild.</td>
<td><code>/setnotifications levelups setting:Disabled apply-to-all-channels:True</code>, <code>/setnotifications achievements setting:All</code></td>
</tr>
<tr>
<td><code>/notificationchannel set</code></td>
<td>Send all notifications to a single channel.</td>
<td><code>/notificationchannel set #spam</code></td>
</tr>
<tr>
<td><code>/prefix set &#x3C;prefix></code></td>
<td>Set command prefix to the </td>
<td><code>/prefix set --</code></td>
</tr>
</tbody>
</table>

Command and syntax	Description	Usage
`/listlocale`	Shows list of supported languages	`/locale list`
`/locale set <language>`	Set language of the bot to your preference. Work In Progress - Untranslated strings default to English.	`/locale set spanish`
`/setnotifications <levelups/achievements> <All/Disabled/RewardsOnly> <apply-to-all-channels>`	Allows you to configure notifications for your guild.	`/setnotifications levelups setting:Disabled apply-to-all-channels:True`, `/setnotifications achievements setting:All`
`/notificationchannel set`	Send all notifications to a single channel.	`/notificationchannel set #spam`
`/prefix set <prefix>`	Set command prefix to the	`/prefix set --`

Guides

Modules

Settings Module