Table of Contents:

All MeowHelper Commands

Basic User Settings:

Every MeowHelper feature is completely optional, but by default most features are enabled.

/toggle

Toggle is the base command for all user specific settings. Some toggles have multiple modes or an additional toggle setting tied to them to refine a feature further. Toggles do not control any server settings.

/toggle pings
Pings configure whether you will be mentioned for certain activities.

• Timer Ping - When enabled, timers will mention you (if react mode is disabled)

• Rare Ping - Pings upon encountering a rare or high value species

• Rare Ping Spam - Increases the rare ping to 5 lines of pings to get your attention

• Held Item Ping - Pings upon encountering a spawn with a held item

• Clan Goal Ping - Pings upon completing one of your clan's catch goals

• Personal Hunt Ping - Pings upon encountering one of your personal hunts

• Faction Hunt Ping - Pings upon encountering one of today's faction hunts

• Quest Alert - Pings or Private Messages you when you can get a new quest

• Catchbot Alert - Pings or Private Messages you when your Catchbot has returned

• Alert Mode - Switch between Channel Pings, Private Messages, or turning off Alerts

/toggle timers
Timers inform you when your command is ready to be used again.

• Timers Feature - Enable or Disable the entire Timers feature (preserves settings)

• React Mode - Enables a ✅ reaction in place of new messages for short timers

• Quiet Mode - Disables messages that indicate when your timer has been set

• Ping Mode - When enabled, timers will mention you (if react mode is disabled)

You may also Enable or Disable timers for individual game commands. Some timers may be disabled regardless of your Toggle preference if there is no longer a cooldown in game.

/toggle utilities
Utilities control various MeowHelper functions. 

• Fish Rarity - Shows fish rarity upon encountering a fish

• Fish Embed - Toggles fish rarity messages between embeds (enabled) or normal (disabled)

• Recommended Ball - Shows the recommended ball and catch rate based on the market value, ball value, and rarity, upon encountering a rare spawn

• Rare Spawn Privacy - Shows your username and a link to the spawn message in the rare spawns channel unless enabled

• Rare Spawn Value - Shows the last known market value upon encountering a rare spawn

• Weakness Mode - Control how much of the battle weakness chart is displayed when an opponent sends out a Pokemon during a battle.

Modes:

• • • • Full - Shows all weaknesses (0x, 1/4x, 1/2x, 1x, 2x, and 4x)

      • Medium - Shows 1x, 2x, and 4x

      • Truncated - Shows 2x or 4x only

      • Off - Disables the Weakness Mode feature

Basic Utilities:

Utilities are various MeowHelper functions that apply to individual Users, Servers, and Clans. This section covers commands for Utilities that Users can take advantage of. These features are more advanced than the toggleable (generic) things done upon every encounter.

/statistics

Upon every encounter and battle, MeowHelper increments your Personal, Server, and Clan Statistics. There are Permanent and Temporary Statistics. This includes information such as your catch rate by rarity, eggs hatched by rarity, estimated market value by type of encounter, and battle stats.

/statistics view <category> <type>

View your Personal, Server, or Clan Statistics (Temporary or Permanent).

/lookup

View information about a specific species.

/lookup pokemon
View information in the MeowHelper database about a specific species. This includes the last known market value (if any), adjusted catch rate (if any), and exclusive type (if any). All other other generic information known about this species in the database is also displayed.

/lookup weakness
View the Full Battle Weakness Chart for a specific species manually.

/water-state

View information about the current Water State, including a timestamp on the last known results from the Seaflute. There are no subcommands for Water State. To set up a channel to automatically post when the Water State changes and ping roles (optional) for Golden Hour or Calm Waters, see the /manage command.

/hunts

Hunts track a targeted amount of catches for a specific species, as well as how many were found total. Hunts are kept in the database even after the target amount is reached, and must be ended manually before creating a new one to start a new Hunt for the same species with 0 progress towards it. The target amount is per user, but is unlimited if not set. An announcements channel can be set using /manage channels general to announce when a user has completed a Server Hunt or using /manage channels clan for Clan Hunts, which will post when someone meets the target amount, or for every catch if it is unlimited. NOTE - Clan features require additional setup using /clan in order for them to function properly.

/hunts create <scope> <pokemon> <opt: amount> <opt: duration>
Create a new Personal, Server, or Clan Hunt with an optional duration. To add a duration, enter the time from now this hunt should end in format DD:HH:mm (ex: 01:02:03 = 1 day, 2 hours, and 30 minutes from right now).

/hunts view <scope> <opt: pokemon>
View current Personal, Server, or Clan Hunt progress. To see other user's Server or Clan Hunt progress, use the optional pokemon input for a specific species (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Read Only Admin, Whitelisted Event Host). Viewing Personal Hunts does not support the option to input a specific species. 

/hunts end <scope> <pokemon>
Ends an existing Personal, Server, or Clan Hunt. Note that you can no longer view this hunt as it is deleted from the database. Be sure to view any needed information prior to ending a hunt.

/goal

Goals track a targeted amount of catches. Goals are never deleted automatically, but may optionally reset Daily, Weekly, or Monthly. There are Personal, Clan, and Server goals. NOTE - Clan features require additional setup using /clan in order for them to function properly.

/goal create <amount> <name> <scope> <opt: reset-period>
Create a new Personal, Clan, or Server Goal.

/goal view <opt: goal>
View current Personal, Clan, and Server Goal progress. To see other user's Clan or Server Goal progress, use the optional goal input (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Read Only Admin). Viewing Personal Goals does not support the option to input a specific Goal Name. 

/goal reset <goal>
Resets tracked progress on a Personal, Clan, or Server Goal manually.

/goal update <goal> <new-amount> <opt: reset-period>
Updates the target amount and optionally the reset period of a named Personal, Clan, or Server goal without resetting progress.

/goal delete <goal>
Deletes a Personal, Clan, or Server goal from the database. Note that you can no longer view this goal after using this command. Be sure to view any needed information prior to deleting a goal.

/swaptracker

Swap Tracker keeps track of your swaps after you start it. This includes the number of swaps, rates at which you obtained each rarity, and the estimated market value. You may only have 1 swap tracker running at a time, and it cannot be temporarily disabled. You can manually end your Swap Tracker, or it will end automatically once you have met the desired number of swaps.

/swaptracker start <name> <amount>
Starts a new Swap Tracker with a Name and Amount of pokemon to be tracked.

/swaptracker view
View current Swap Tracker progress and tracked information.

/swaptracker end
Ends your Swap Tracker manually and deletes all tracked information in the database.

/help

Displays useful links and contains an interactive drop-down menu where you can view information about specific commands.

Server & Clan Settings:

Every MeowHelper feature is completely optional, but by default most features are enabled. This section details all Server and Clan settings. Most of these settings have no defaults and need configured prior to use of their related features. Personal settings are configured with /toggle. Clans require setup with the /clan command to enable MeowHelper Clan features!

Server Settings:

/manage

The Manage command allows you to set channels, roles, and other settings for your server. When a Channel or Role is not set, the related feature or a portion of it is disabled.

Black and White Lists:

/manage roles events <role-type> <role> <action>
Manage what role MeowHelper should Globally Whitelist or Blacklist for your Clan and Server Events. You may only choose 1 role to Globally Blacklist or Whitelist. If you set a Globally Blacklisted role, holders of this role are Blacklisted even if they also hold a Whitelisted Event role. If you set a Globally Whitelisted role, you must hold this role to participate in the event unless you hold a set Event Whitelisted role. Even if you hold a Globally Whitelisted role, if you also hold an Event Blacklisted role, you will be Blacklisted. Event roles are managed under /events manage-roles. (NOTE - If the Global setting is used when creating a specific Clan Event, participation will be restricted to the set Clan Server, if one is set.) 

/manage whitelist <role> <meow-helper-guild-permission> <action>
Manage what roles can execute Admin level commands for MeowHelper in your Clan or Server. 

MeowHelper Permission Levels Explained:

• Admin - Execute any Admin commands for all features.

• Read Only Admin - Execute any Admin commands that only View and do not Change any settings, utilities, or events.

• Event Host - Execute any Admin commands related to all Events.

• Lottery Host - Execute any Admin commands related to Lotteries.

• Giveaway Host - Execute any Admin commands related to Giveaways.
  
  

Channels and Roles:

/manage channels general <channel-type> <channel> <action>
Manage what channels MeowHelper posts in for things such as Water State, Server Hunts, Server Events, Server Goals, and Rare Spawns. 

/manage roles general <role type> <role> <action>
Manage what roles MeowHelper pings for things such as Golden Hour, Calm Waters, or when a Lottery Starts. Requires related channels/messages to be set or activated for a ping to actually occur. 

/manage channels clan <type> <channel> <action>
Manage what channels MeowHelper posts Clan related content in for things such as Goals, Hunts, and Events. NOTE - Clan features require additional setup using /clan in order for them to function properly.

/manage channels pokemon <channel> <pokemon> <action> <opt: maximum-price> <opt: role>
Manage your server's Pokemon Market posts, which is a Premium feature. Each species (managed with a pokemon entry) can have it's own settings. If a Maximum Price is not set, then it will post each time there is a new Market Offer for this species.

/manage channels snipe <channel-type> <channel> <action>
Manage what channels MeowHelper posts Market Snipes in, which is a Premium feature. Each rarity can have it's own channel if desired, or they can be grouped or combined in any way. It is recommended to use channels that do not contain any Market Feeds (optional free feature) since Market Snipe is a Premium feature that cuts down posts to a minimum discount percentage (manageable with /manage snipe-discount). Pings can be enabled by configuring roles.

/manage roles snipe <role-type> <role> <action>
Manage what roles MeowHelper pings for Market Snipe posts. Each rarity can have it's own role if desired, or they can be grouped or combined in any way.

/manage channels market <channel-type> <channel> <action>
Manage what channels MeowHelper posts Market Offers in. Each rarity can have it's own channel if desired, or they can be grouped or combined in any way. It is recommended to use channels that do not contain any Market Snipe or Pokemon market channels since these are Premium features that cut down posts to more customized and relevant offers only. Pings can be enabled by configuring roles.

/manage roles market <role-type> <role> <action>
Manage what roles MeowHelper pings for Market Offer posts. Each rarity can have it's own role if desired, or they can be grouped or combined in any way.

Misc. Settings:

/manage snipe-discount <discount-percentage>
Change your server's Market Snipe discount percentage. Market snipe requires setup with the /manage channels command (and optionally /manage roles) and is a Premium feature. Rates should be entered in decimal form (ex: 30% would be 0.30 or 0,30 depending on how it is represented in your region). A discount of 30% (default) would mean a species with a market value of 1000 would need to be offered at 700 or less for it to post in it's relevant Market Snipe channel.

Looking to view your already configured settings? Try using /view

Viewing Settings:

/view

Viewing current Server and Clan Settings is a good way to troubleshoot why a feature is not working as expected, or seeing which features may be disabled. 

/view server event-blacklist
View your server's Event Blacklisted Roles.

/view server whitelist
View your server's Whitelisted Roles for executing Admin commands.

/view server general-settings
View your server's General Settings.

/view server pokemon-settings
View your server's Pokemon Market Channel and Role settings.

/view server snipe-settings
View your server's Market Snipe Channel and Role settings.

/view server market-settings
View your server's Market Feed Channel and Role settings.

/view clan settings
View your MeowHelper Clan's settings.

Clan Settings:

/clan

Clans enabled features such as /statistics, /goal, /hunts, and /events, all require a real Clan's Owner or Co-Owner to be listed on the ;clan page to use clan commands initially. They can set a Clan Server and whitelist role(s) for additional users to be able to manage clan commands if desired. Otherwise, only the current Owner or Co-Owners can use Clan commands. To view your MeowHelper Clan settings, use /view clan settings.

/clan set-server
Associates your MeowHelper Clan with the server the command is used in. If your MeowHelper Clan is already associated with a server, it will be updated to the server this command is used in. (NOTE - Setting a clan server requires you to be an Owner or Co-Owner of a clan and requires at least one of the following permissions: Server Admin, Whitelisted Admin).

• You MUST use the ;clan command and be a listed Owner or Co-Owner BEFORE setting your MeowHelper Clan Server! (If anyone in the clan has typed ;clan in a MeowHelper enabled server since you became an Owner or Co-Owner, this should work properly)

• EACH Clan Member must also use the ;clan command once the MeowHelper Clan is created in order to be automatically added to the MeowHelper Clan.

/clan member-list
Displays a list of members in your MeowHelper Clan.

/clan remove <user>
Removes a user from your MeowHelper Clan manually. This is recommended when a Clan Member leaves or is kicked from your clan. Users are also removed automatically if they use the ;clan command after leaving or being kicked in any server with MeowHelper. (NOTE - Requires you to be in the same MeowHelper Clan and requires at least one of the following permissions: Server Admin, Whitelisted Admin).

/manage channels clan <type> <channel> <action>
Manage what channels MeowHelper posts Clan related content in for things such as Goals, Hunts, and Events.

/view clan settings
View your MeowHelper Clan's settings.

Server & Clan Utilities:

The main Server and Clan Utility is Events. Servers and Clans can also take advantage of certain other basic utilities such as Hunts and Statistics. Clans can take advantage of Goals as well. (NOTE - Creating Server or Clan Events requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Event Host, or Clan Owner/Co-Owner for Clan Events only)

/events

Servers and Clans can host various events through MeowHelper, which is a Premium Feature requiring an active Patreon subscription. Staff can Blacklist certain roles from participating in Events if desired using the /manage roles events command. Clan Events are tracked in all servers that MeowHelper is in, not just the clan server. This is also true of Clan Goals, Clan Hunts, and Clan Statistics (see /goal, /hunts, and /statistics to use those features). NOTE - Clan features require additional setup using /clan in order for them to function properly.

Promos (premium):

/events promo create <name> <currency-symbol> <prize-type> <prize> <opt: catch-rate> <opt: fish rate> <opt: battle rate> <opt: explore-rate> <opt: scope> <opt: currency-per-exchange> <opt: blacklist-entry-mode> <opt: black-listed-role>
Creating a new Server or Clan Promo a lot of options. (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Event Host, or Clan Owner/Co-Owner for Clan Events only)

Promo Creation Options Explained:

• Name - Enter a name to keep track of this promo

• Currency Symbol - Enter an emoji or other text as the "item" that will drop in your promo. Emojis must be from a server that has MeowHelper currently in it to display properly.

• Prize Type - Pokemon, Coin, or Other.

• Prize - If Pokemon, enter the dex number or name. If Coin, enter the amount. If Other, enter any text you desire.

• Catch, Fish, Explore, and Battle Rates - Enter the rate at which users can randomly obtain "drops" of the Currency Symbol "item" if that method is desired. At least one "Rate" is required to successfully create a promo. Rates should be entered as the denominator of the fractioned drop rate in integer form or x where 1/x is the drop rate (ex: for a 1 in 1000 drop rate just enter 1000). Unspecified rates or 0 will make this item drop method disabled.

• Scope - Server or Clan. If not specified, the default will be Server.

• Currency per Exchange - The number of "drops" of the Currency Symbol "item" required to claim a promo.

• Event Role Entry Mode - Optionally limit who can participate Global (uses the settings controlled in /manage event-blacklist and settings for this event), or Event (uses the settings for this event only managed with /events manage-roles). If not specified, the default will be Global. If a user has a whitelisted and blacklisted roles, they will be blacklisted until they only have whitelisted roles. (NOTE - Requires the Clan Server to be set for Clan Promos to have a functional Role Entry Mode. If the Clan Server is set and any Event Role is set, Clan Promos will also be disabled for all users in all servers EXCEPT for the set clan server. If you wish to allow all Clan Members to participate in a Clan Drop in all servers, choose Event and do not add any white or black lists to this event)

/events promo claim <name> <type> <user>
Claim a promo by redeeming a user's promo currency for the prize. (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Event Host, or Clan Owner/Co-Owner for Clan Events only)

Drops (premium):

/events drop create <name> <prize> <prize-type> <opt: catch-rate> <opt: fish rate> <opt: battle rate> <opt: explore-rate> <opt: is-unique-winners> <opt: number-of-winners> <opt: scope> <opt: event-role-entry-mode>
Creating a new Server or Clan Drop a lot of options. (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Event Host, or Clan Owner/Co-Owner for Clan Events only)

Drop Creation Options Explained:

• Name - Enter a name to keep track of this drop.

• Prize Type - Pokemon, Coin, or Other.

• Prize - If Pokemon, enter the dex number or name. If Coin, enter the amount. If Other, enter any text you desire.

• Catch, Fish, Explore, and Battle Rates - Enter the rate at which users can randomly obtain Drops if that method is desired. At least one "Rate" is required to successfully create a drop. Rates should be entered as the denominator of the fractioned drop rate in integer form or x where 1/x is the drop rate. (ex: for a 1 in 1000 drop rate just enter 1000). Unspecified rates or 0 will make this drop method disabled.

• Is Unique Winners - If True, an individual user can only win this drop 1 time. If false, an individual user can win this drop multiple times. If not specified, the default will be false.

• Number of Winners - The total number of times that a Drop can be won before the event ends.

• Scope - Clan or Server. If not specified, the default will be Server.

• Event Role Entry Mode - Optionally limit who can participate Global (uses the settings controlled in /manage event-blacklist and settings for this event), or Event (uses the settings for this event only managed with /events undefined-command). If not specified, the default will be Global. If a user has a whitelisted and blacklisted roles, they will be blacklisted until they only have whitelisted roles. (NOTE - Requires the Clan Server to be set for Clan Drops to have a functional Role Entry Mode. If the Clan Server is set and any Event Role is set, Clan Drops will also be disabled for all users in all servers EXCEPT for the set clan server. If you wish to allow all Clan Members to participate in a Clan Drop in all servers, choose Event and do not add any white or black lists to this event)

Event Tools:

/events manage-roles <event> <role> <role-type> <action>
Manage a specific event's white or black listed role. Using this feature will disable the ability to participate in clan events in all servers except for the set clan server, and then it will follow both the Event and Global (server) settings in combination. If you set your clan server to a different server while having a role set during an ongoing event, your event will be disabled until the role is removed or set to one in the current clan server. Global settings also do not apply to Clan Events when the clan server is not set. To manage the Global (server) event white or black list, use /manage roles events (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Event Host, or Clan Owner/Co-Owner for Clan Events only)

/events view <scope> <opt: name>
View a current Server or Clan's Event information. To see other user's Server or Clan Event progress, use the optional name input. (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Read Only Admin, Whitelisted Event Host, or Clan Owner/Co-Owner for Clan Events only)

/events delete <name> <scope>
Deletes a Server or Clan Event from the database. Note that you can no longer view this event after using this command. Be sure to view any needed information prior to deleting an event. (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Event Host, or Clan Owner/Co-Owner for Clan Events only)

/lotto

Server staff can host Private Custom Lottos through MeowHelper, which is a Premium Feature requiring an active Patreon subscription. This can be for Coins or a Pokemon species entered by name or dex number (only supports 1 species, but there can be multiple winners).

• Server Admins and Whitelisted Admins are able to host Lottos.

• You may allow additional server members to host lotteries with a Whitelisted Lottery Host Role using /manage whitelist which is also where you can manage the Whitelisted Admin roles.

• MeowHelper will Lock Threads related to an Ended Lotto when that Lotto ends if it has permission to Manage Threads.

• You can set a server setting for a role for MeowHelper to ping when a lottery begins using /manage roles general.

Coin Lotto (premium):

/lotto create-coin <name> <host> <channel> <ticket-price> <number-of-winners> <lottery-type> <opt: duration> <opt: max-tickets> <opt: custom-tax>
Create a new Coin Lotto with a few options. (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Lottery Host).

Coin Lotto Creation Options Explained:

• Name - Enter a name to keep track of this Lotto

• Host - Tag the user who coins will be sent to to enter this Lotto

• Channel - Select a channel to host this Lotto in (creates an announcement and thread for buying tickets)

• Ticket Price - Enter the number of coins required to purchase 1 Lotto ticket

• Number of Winners - Enter the number of winners the pot will be distributed among

• Lottery Type - Select if this should have a Time Limit, Ticket Limit, or Both.

• Duration - Enter the time from now this Lotto should end in format DD:HH:mm (ex: 01:02:03 = 1 day, 2 hours, and 30 minutes from right now).

• Max Tickets - Enter the number of tickets that can be purchased before the Lotto ends if the Lottery Type is Ticket Limit or Both.

• Custom Tax - Enter the percentage (0-50) at which the entry fee is taxed (portion excluded from the prize pool, kept by the host). Default tax is 25% if not entered.

Coin Lotto Winner Prize Pot Distribution Explained:

• 1 Winner

  1. • 1st: 100%

• 2 Winners 

  1. • 1st: 70%

     • 2nd 30%

• 3 Winners

  1. • 1st: 50%

     • 2nd: 30%

     • 3rd: 20%

• 4 Winners

  1. • 1st: 40%

     • 2nd: 30%

     • 3rd: 20%

     • 4th: 10%

• 5 Winners

  1. • 1st: 30%

     • 2nd: 25%

     • 3rd: 20%

     • 4th: 15%

     • 5th: 10%

Pokemon Lotto (premium):

/lotto create-pokemon <name> <host> <channel> <pokemon> <ticket-price> <number-of-winners> <lottery-type> <opt: duration> <opt: max-tickets>
Create a new Pokemon Lotto with a few options. (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Lottery Host).

Coin Lotto Creation Options Explained:

• Name - Enter a name to keep track of this Lotto

• Host - Tag the user who coins will be sent to to enter this Lotto

• Channel - Select a channel to host this Lotto in (creates an announcement and thread for buying tickets)

• Pokemon - Enter the dex number or name of the Pokemon to create a lottery for (limit species).

• Ticket Price - Enter the number of coins required to purchase 1 Lotto ticket

• Number of Winners - Enter the number of winners the pot will be distributed among

• Lottery Type - Select if this should have a Time Limit, Ticket Limit, or Both.

• Duration - Enter the time from now this Lotto should end in format DD:HH:mm (ex: 01:02:03 = 1 day, 2 hours, and 30 minutes from right now).

• Max Tickets - Enter the number of tickets that can be purchased before the Lotto ends if the Lottery Type is Ticket Limit or Both.

Lotto Tools:

/lotto roll <thread>
Roll the winners of a coin lottery early (before the time/ticket limit), or roll/reroll the winner(s) of a Pokemon lottery. You must join the thread to use this command by sending a message in the thread first. (NOTE - Requires at least one of the following permissions: Server Admin, Whitelisted Admin, Whitelisted Lottery Host).

/lotto view <opt: thread>
View all ongoing lotteries. If you optionally choose to view a specific thread of an ongoing lottery, you will see current detailed lottery information. For a past lottery, you can optionally choose it's specific thread to view the full history of rolled winners.