Configuration.md

@@ -2,14 +2,14 @@ General configuration options help you customize the plugin's experience or prov
 
 Storage
 -------
-MCCosmetics supports several ways of storing your player data, defined by `Storage.Driver` in your `config.yml` file.
+MythicCosmetics supports a couple ways of storing your player data, defined by `Storage.Driver` in your `config.yml` file.
 
 **Note that this only includes what cosmetics players are using - cosmetics players have unlocked are stored using permissions.**
 
 #### Supported Storage Drivers
 | Driver | Description |
 | ------ | ------ |
-| JSON   | Default, stores data in .json files in the MCCosmetics folder |
+| JSON   | Default, stores player data in .json files in the `MythicMobs/data/cosmetics` folder |
 | MYSQL  | Stores all player data in a MySQL Database |
 
 ##### Database Configuration (MySQL)
@@ -40,6 +40,29 @@ Menus
 -----
 ### Menu Configuration
 
-All menus come preconfigured to show you how it's done. Basically each cosmetic type has a selection_cosmetictype menu that uses the schema system coming to many mythic plugins. 
+Menu configuration files are located in `plugins/MythicMobs/config/menus/cosmetics`
 
-The $ is default to the cosmetics in the menu, and the rest are determined with the mappings below. The page buttons and back button need to be named the same to work. A dedicated menu page will be coming.
+Inside the menu configs folder:
\ No newline at end of file
+- `cosmetics.yml` - The main cosmetic category menu
+- `selection.yml` - The generic 'select your cosmetic' menu.
+- `selection_[type].yml` - If this is found for specific cosmetic types, it will load a custom menu for that type so you can individualize them (e.g. `selection_hats.yml`). Uses the same format.
+
+When configuring a menu schema, the `$` symbol is where data will be auto-filled, such as the icons for each cosmetic. Special buttons, or custom buttons you make, are mapped to other letters/numbers in the config.
+
+Special buttons such as the page buttons and back button need to be named the same to work.
+
+#### Special Buttons in `cosmetics.yml`:
+- `BUTTON_[TYPE]` - clicking a button named this will open that cosmetic selection menu (such as `BUTTON_HATS`
+
+#### Special Buttons in `selection.yml`:
+- `BACK` - The back button
+- `NEXT_PAGE` - Next button for pagination
+- `PREVIOUS_PAGE` - Previous button for pagination
+- `EQUIPPED` - Shows the currently equipped cosmetic
+- `REMOVE_COSMETIC` - Removes the currently equipped cosmetic
+- `SEARCH` - Lets you search thru cosmetics
+- `SEARCH_RESET` - Resets the search functionality
+- `FILTER` - A button that toggles between showing All cosmetics, Collected, and Favorites
+- `FILTER_ALL` - Icon for the "Showing All" button (replaces the `FILTER` button, doesn't need to be mapped)
+- `FILTER_COLLECTED` - Icon for the "Showing Collected" button (replaces the `FILTER` button, doesn't need to be mapped)
+- `FILTER_FAVORITES` - Icon for the "Showing Favorites" button (replaces the `FILTER` button, doesn't need to be mapped)