Getting Started

Learn how to setup Pi-mon for use on your server.

Add Pi-mon to Your Server

Once Pi-mon is in your server, to open up the setup menu, use the /setup command in any channel of a server Pi-mon has been added to. This will open a dashboard that shows some configured settings and gives you the option to edit those settings and set up the regions / categories of your masterlist. Click Edit Settings to start.

  1. Roles

    In this section, you should select the role(s) you have designated for your server's staff.

    • Mod Role (required): All users assigned this role will be able to approve and deny reservations and submissions within this server.
    • Force Drops Role (optional): Set this role to designate what staff members can use force drop commands without having Administrator permissions in the server. Leave this dropdown empty to keep force drop commands Administrator only.

    Simply click the dropdowns and select the role(s) you need, then click Next -> to move forward.

  2. Mod & Masterlist Channels

    Here you have three channels required.

    • Mod Log: This channel will be used as a log for all actions taken using Pi-mon within the server.
    • Mod Queue: This channel will show all tasks that have yet to be completed by server staff. Any user with the Mod Role can interact with the tasks in this channel. This is meant to be a staff-only channel.
    • Masterlist: This channel is where your masterlist will be published for all to see! Make sure you don't send any messages after Pi-mon's message as Pi-mon will need to re-send the masterlist in the channel every so often.

  3. Player Channels

    These are the channels that players will mainly be interacting with Pi-mon in.

    • Reservations: This channel will be used by players to reserve available characters on the masterlist. They will use the /reserve command
    • Submissions Forum: This channel will be used by players to create posts for their application to claim a specific character. Once created, they will use the /submit command inside their own post.

  4. Server Defaults

    These are the default limits for the character cap and reservation duration. You can accept these defaults and finish, or edit them.

    • Default Character Cap: This is the default maximum number of characters a player in your server will be allowed to have. Per-player overrides can be set later by staff using the /set_cap command.
    • Reservation Duration: This is how long a reservation lasts before it expires. When players are looking to claim a character, they create a reservation which holds that character for an amount of time while they work on their application. If they do not complete their submission before time is up, their reservation will expire and the character will be open to new reservations.

Once you finish, Pi-mon confirms the setup wizard is complete and directs you to import characters and post the masterlist. To configure regions, run /setup again and click Manage Regions.

Regions

Clicking Manage Regions opens a menu where you can create and edit the regions / categories your masterlist is organized into. If you haven't created any yet, click Add Region to make one.

The Add Region form has three fields:

  • Region Name: This is how you'll select the region in other commands, like when importing characters or editing the region later. It should be plain text only, no special characters or emojis.
  • Display Title (optional): This is what's shown publicly on the masterlist, and unlike Region Name, it can include emojis or other decorations.
  • Color (optional): A hex color code (e.g. #5B9BD5) that sets the color of that region's section on the masterlist embed.

You can edit a region at any time by selecting it and once you've created multiple regions, you can change where they appear in the masterlist. Selecting a region opens a panel where you can rename it, change its display title or color, delete it, or use Move Up / Move Down to reorder it.

Importing Your Roster

Once your channels and regions are set up, it's time to get your characters into Pi-mon.

  • /import_characters to bulk-import your roster from a CSV file (region, character, and user_id columns). The user_id column is only needed for characters that already have a claim in your server, leave it blank for anything still available.
  • Or /import_character to add characters one at a time.

Once your characters are imported, run /masterlist_post to publish the masterlist.