Getting Help

Using Help:
- Type =categories to see a list of command categories.
- To see help for a specific command, type =whatis COMMAND, such as whatis create
- For quick references, use =cheatsheet setup, spar, player, admin, gm, hunt, quests, or encounter.
- To see easy explanations on basic bot functions, type =explain TOPIC. To see a list of topics, just type =explain.
- For support, type =support to see advanced wiki documentation and the support server link.

Getting Started

Required Permissions

The bot should be granted proper permissions in the invite, but the following Discord permissions are needed:
• Read Text Channels and See Voice Channels
• Manage Roles
• Manage Webhooks
• Manage Messages
• Send Messages
• Read Message History
• Read Messages
• Embed Links
• Attach Files
• Add Reactions

The user setting up the bot must have at least Manage Server permissions.

There are two options for setting up the bot: default and custom. For default setup:

• Type =createroles for the bot to create the four required management roles.
• Type =addadmin @user1 @user2 (Discord mentions) to set bot administrators.
• Type =loaddefault to load basic spells, monsters, items, armaments, and melee attacks to the server.
• Type =addgm @user1 @user2 for game moderators.
• Type =addplayer @user1 @user2 for roleplayers.

For custom setup:

•Type =setadminrole @DiscordRole (role mention) to set the bot admin role.
• Type =newsetup to start the DM setup of the server settings, like starting HP and bank balance.
• Type =setgmrole @DiscordRole (role mention) to set the bot GM role.
• Type =setplayerrole @DiscordRole (role mention) to set the roleplayer role.

Bot Roles

Admin: The admin can run all commands of the bot, such as adding and deleting spells or items. A user with manage server permissions must set the admin role.

Game Moderator: The game moderator is able to start random encounters, add or delete monsters, give money, and give items.

Alt Manager: The Alt manager is able to create, edit and delete Alts.

Player: A player is able to add, edit, and delete their character profile, and play as their character, and post as Alts if allowed, and buy and sell items, and trade with other players. An admin role user must approve new characters.

How to create a character

Run =create to activate a new character. Most fields are free text except Class and Race. Use =listrace or =listclass to see their attributes. A picture is optional, you may type None for no picture.

Once your character is created, run =classcanuse to see the melee attacks, spells, buffs, items and armaments your class can equip and use. Ask a GM or RP Admin to grant them to you. You may also buy items, spells, melees, and buffs from trainers and vendors with =buy and armaments with =buyarms.

To see details of anything, use =listitem, =listmelee, =listspell, =listbuff, or =listarmament, followed by the name, such as =listspell Fireball.

Once your character has armaments, you may equip them with =equip.

Random Sparring

To spar your character against the bot one-on-one, type =randomspar LEVEL where level is the level of the character you'd like to face down in the ring, such as =randomspar 10. The bot will ask you to confirm your spar with =yes or =no.

If you confirm the spar, the AI character and your character will be added to the spar event. Type =spar2 and a reaction menu will appear with your character list. Press the number reaction associated with your desired character, and the bot will confirm the selection.

Finally, to initiate sparing, type =spar3, and the bot will display the fight menu, where you can react to use a melee, spell, buff, or item. If you choose a weapon attack, the character will automatically dual-wield both armaments equipped in the hand slots. For melees, buffs, or spells, you will be prompted for a target. If you select yourself, you will attack yourself, so be careful! You may also pass on your turn.

Single Player Monster Encounters

Similar to other commands, you can view the entire monster list with =listmonsters and view an individual monster's stats with =listmonster MONSTER_NAME, such as =listmonster Imp.

To initiate a monster encounter by yourself, simply type =monster1 and you will be added to the encounter party.

Type =monster2 to select a character in the next reaction menu. Once you have confirmed the character, type =monster3 to select a monster.

Once you have selected a monster, the same fight menu will appear, and the monster will attack after each of your turns.

Dungeon Quests

To initiate a single-player dungeon quest, type =quest1. The bot will initiate a server party with only you as the player.

To select a character for the dungeon run, type =quest2 and the bot will display the character selection reaction menu. React to the emoji corresponding to your desired character, and the bot will confirm the selection.

Finally, to enter the dungeon, type =quest3 SIZE LEVEL, where SIZE is the number of rooms in the dungeon in a square, so SIZE 2 will produce a 2x2 dungeon of four total squares. LEVEL determines the approximate level of monsters, critters and the final boss.

Once you have begun the dungeon, the bot will drop you into a random room in the dungeon. The final room contains the boss and biggest load of loot, and is also randomized, so look everywhere!

Directions are north, south, east and west. The map runs from (0,0) in the upper left corner to (X,X) in the lower right, where X is the SIZE from =quest3. The bot will not allow you to navigate out of the dungeon walls.

You should check every room with the look command, which on the navigator is . The bot will tell you if nothing is present, or if there is treasure to find. If a monster or critter is lurking in the dungeon, it will appear and begin an encounter which will bring up the fight menu.

If you are defeated by the monster, the quest is over and you will keep your loot and earn some experience from the dungeon. If you defeat the monster, you can look in the room again for treasure. After the bot says the room is cleared, then navigate in one of the four cardinal directions.

When you find the final room, the boss, a higher level monster than the others, will appear immediately when you look. If you defeat the boss, the bot will tell you that the quest is over and distribute the loot to your inventory and grant all experience earned.

Mass Sparring

A mass spar is a spar between two or more player characters. Any player or a GM may initiate a mass spar with =spar1 @User1 @User2... where @User is a Discord mention of the players to spar.

Each player can confirm or deny the spar challenge with =yes or =no. If at least two players confirm, the spar may proceed. Players who respond with =no will be dropped from the spar.

Once a player has confirmed the spar, all players must select a character with =spar2, which will request a character from the reaction menu. Players can then select their desired characters from the reaction menu.

Once all players have confirmed the spar challenge and selected a character, any player in the spar may type =spar3 to begin the spar. The bot will mention who gets to strike first and the fight menu will be displayed.

Once the spar begins, players may attack as usual using the fight menu, either attacking, using an item or buff, or passing. When an attack or buff is selected, the player will be asked who to target, and then that character will be attacked. The turns will then proceed in order until one player is left standing, who is the winner!

Party Monster Encounters

Similar to other commands, you can view the entire monster list with =listmonsters and view an individual monster's stats with =listmonster MONSTER_NAME, such as =listmonster Imp.

To initiate a monster encounter with other players, simply type =monster1 @User1 @User2...

All players will be prompted to select a character via reaction menu. Select a character, then type =monster2 to select a character in the next reaction menu.

Once all players have confirmed their characters, type =monster3 to begin the encounter. The same fight menu will appear, and the monster will attack after each of your turns.

Note: Only GMs can initiate multi-user monster encounters, and GMs may manually attack with the monster at any time with =monsterattack.

Party Dungeon Quests

Party dungeon quests are similar to single-player, with the following exceptions:

* Only GMs may initiate a multiuser dungeon run.
* To start a party quest, type =quest1 @user1 @user2 where @user is a Discord mention.
* Any player in the party can use any of the navigator functions at any time, so cooperate somehow!
* When a monster encounter occurs, the party will engage the monster as if it were a multi-player one.
* Loot is randomly given to players in the party when found, not by who looked in the room.

What Character Statistics Mean in Fantasy Prime

Attack: The base number for melee combat damage. Multiplied by the melee damage multiplier or added to weapon damage.

Defense: The total defense against all damage the character has. Added onto by buffs or armaments and subtracted from total damage.

MagicAttack: The base number for spell damage. Multiplied by the spell damage multiplier.

Health: The amount of health a character has. When this reaches zero during sparring or monster encounters, the player is out of the group. Can be restored by buffs or items.

MaxHealth: The maximum health of the character.

Mana: The amount of mana for spells. When this reaches zero, a character must pass, use melee attacks or an item.

MaxMana: The maximum mana of the character.

Level: The character's current level, which determines health, mana and stamina. Also determines the experience gained by combat with characters or monsters of different levels.

Experience: The amount of experience a character has. To level up, a character must earn 20 times (default) their current level in experience points.

Stamina: The amount of stamina a character has for melee combat. When this reaches zero, a character must pass or use a spell or item.

MaxStamina: The maximum stamina of the character.

Agility: How likely a character is to dodge an attack. Higher agility means greater speed. Dodge is calculated as a 10% chance if your agility is lower and 25% chance if your agility is higher.

Intellect: The amount of defense against magic spells a character has. It's basically armor against magic spell attacks.

Charisma: How likely a discount is from a vendor.

Character Profiles

CharacterName: Name of the character.

Age: The age of the character

Race: The race of the character (human, vampire, etc). If the server has races defined, it must be one of those races or "None". Race determines bonuses or deficiencies in statistics.

Gender: The gender, if known of the character (male, female, etc)

Height: The usual height of the character, if known (5'5'', 10 cubits, etc)

Weight: The mass on the current world of the character (180 lbs, five tons, etc)

Playedby: The name of the artist, human representation, actor, etc who is used to show what the character looks like (Angelina Jolie, Brad Pitt, etc)

Origin: The hometown or homeworld of the character (Texas, Earth, Antares, etc)

Occupation: What the character does for a living, if applicable (blacksmith, mercenary, prince, etc)

Class: The class of the character. Class determines what items, spells, armaments, melee attacks, and buffs a character may equip or use.

PictureLink: A direct upload or http link to a publicly accessible picture on the Internet (None for no link). Google referral links don't always work

Notes

All fields are free text except Race and Class. Those must be from the server-defined list. PictureLink needs to be a direct image link, and often sites like Google or Tumblr will block references. You may upload a picture directly to the bot as a response to the message and it will use that for your character.

Critter Spawns and Pets

Critters may spawn in the channel set by the =setcritterchannel command, randomly, based on server activity. They will be varying levels and powers.

You may hunt or attempt to catch a critter. To hunt the critter, type =hunt and you will enter a monster-like encounter with the critter after selecting a character. If you defeat the critter you will gain experience!

To attempt to catch a critter, type =catch and the critter will either be caught and turned into a pet or it will escape. To set a name for the pet, use =changepet.

GMs and above may spawn critters manually using the =spawncritter command.

Buying and Selling

You may buy from vendors set up in the bot. Vendors can sell items, melee attacks, spells, and buffs. Armories can sell armaments.

To see all vendors on a server, type =listvendors. To see a particular vendor's selection and prices, type =listvendor NAME, such as =listvendor Blacksmith.

The same goes for armories, with =listarmories and =listarmory, respectively.

Your character doesn't have unlimited funds, and neither do the vendors (though the default is quite high). To check your currency, type =wallet CHARACTER_NAME or use the player menu.

To buy from a vendor, type =buy and then select a character to buy for using the reaction menu. Once a character is selected, select your desired vendor from the next menu. Finally, an item list will come up.

For now, you need to type in the ID of the item you wish to buy rather than using a reaction menu. This will be fixed in a future release.

To buy from an armory, type =buyarms.

If you looted an item or were granted one you cannot use, you may sell it back to the bank for half its value using =sell or =sellarms.

Trading and Economy

You can trade items with other characters, including your own. The bot doesn't make the other player give you anything in return, so be sure you trust them! If it's a fair trade or sale, you can also send money to the other character.

To trade an item, use =trade. You will be asked for the character with the item you wish to trade, then an item from their inventory. Finally, you will be presented with a selection of all characters on the server. When you select a character, the item will be traded to that character's inventory.

To trade armaments, use =tradearms.

To send currency to another character, use =sendcurrency.

Inventory

To view any character's inventory, use =inventory CHARACTER_NAME and the character's item and armament inventory will display.

NPCs and Alts

NPCs and alts require the NPCUser role to use.

NPCs (non-player characters) are general characters players may post as to advance a scene, such as bartenders, waiters, or impersonal figures that are not otherwise played. Anyone with the player role may use an NPC, but an NPCUser must create them. To post as an NPC, simply use =postnpc SHORTCUT TEXT. SHORTCUT tells the bot which character to post as, and the TEXT is simply the message.

Alts are similar to NPCs but are used by specific players and only allowed to be used by them. To post as an alt, type =postalt SHORTCUT TEXT like the NPC command. You may also set an alt in a channel for every post using =setalt SHORTCUT in a channel. To unset the alt, type =unsetalt.

Dice

Dice are an alternate system in Fantasy Prime for calculating dodge and damage. If the dice fields are undefined or set to None, then the normal systems are used. If the dice fields are set to valid values, the following apply:

* Character Dice: If a character's dice field is set, then their dice will be used to calculate dodge in spars and encounters.
* Monster Dice: If a monster's dice are set, they will be used to calculate damage against a character.
* Melee, spell, and armament dice: If these dice are set, then the dice will be used to calculate damage by adding the value to the relevant base statistic: armament and rolls against Attack and spell rolls against MagicAttack.

Dice may also be manually rolled at any time using the =roll command.