# Ranks ## Overview The ranks module allows you to give ranks to your virtual players when they join, this module is great to boost your sales, your clients will think a load of people bought ranks and might be more interested in buying one themselves. ### Configuration The configuration of the rank module is really easy but you need to understand each part to avoid making mistakes. #### Ranks chances ```yaml # +-------------------------------------------------------------------------+ # # | | # # | RANKS CHANCES | # # | | # # | Controls how poof players handle their private messages. | # # | | # # +-------------------------------------------------------------------------+ # # This option allows you to set the chance of a poof player getting a rank. # It is a percentage value, so it must be between 0 and 100. # # It must follow the following format: # rank_name: chance ranks: hero: 3 vip: 5 mvp: 10 ``` This is the first and only section the configuration file for this module contains. It's really easy to understand, you can add as many ranks as you want. The name of the role comes first (as the key) and then the chance of getting it (as the value). If you have roles contains spaces, you must add them inside quotes. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.playerpoof.com/playerpoof/modules/ranks.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.