Update Sprays authored by Ashijin's avatar Ashijin
Sprays are a type of cosmetic where the player can "spray" different map arts onto the ground. Sprays are temporary and can be configured to disappear after a certain amount of time, or when a new spray is used.
Sprays are a type of cosmetic where the player can "spray" different map arts or text onto the ground. Sprays are temporary, and can be configured to disappear after a certain amount of time, or when a new spray is used.
These map arts are clientside and do not actually affect the world, so are safe for any types of servers.
## Configuration
Configuration for sprays is simple! Just create or modify a file inside the `sprays` folder within whatever [pack](Packs) you're using with the following:
Sprays go in a configuration file located in any pack:
```plugins/MythicMobs/packs/cosmetics/sprays/your_file.yml```
You can have one or more files in the folder, and a file can have multiple sprays in it.
In addition, the spray image itself should go in the `assets/sprays` folder here:
```plugins/MythicMobs/packs/assets/sprays/your_spray.png```
To add a spray cosmetic, place the image you want to use in the `assets/sprays` folder (unless using text), then create or modify a file inside the `sprays` config folder within whatever [pack](Packs) you want and use the following config format:
```
laugh:
Image: laugh
Display: "Laughing Face"
Description:
- "A laughing emoji"
```
If you want to use text instead of an image, you can specify `Text` instead of `Image` and simply input the text:
```
SUS_SPRAY:
Material: MAP
Model: 0
Display: "&dSus"
hello_there:
Text: '<rainbow>HELLO THERE!'
Display: "HI"
Description:
- "&fLookin kinda sus"
- "say hello!"
```
#### Basic Options
**Sprays have the following options**:
* `ID` - *The ID of the cosmetic* (in this case `SUS_SPRAY`)
* `Material` - *The material the cosmetic model is attached to in your resource pack*
* `Model` - *The CustomModelData number the cosmetic model is attached to in your resource pack*
* `Display` - *The display name of the cosmetic in menus*
* `Description` - *The lore of the cosmetic in menus*
Sprays must also have a matching .png file in the same folder as the config file, with the name `[id].png` (where [id] is the ID of the spray).
\ No newline at end of file
| Option | Description |
| ------ | ----------- |
| `ID` | The ID of the cosmetic |
| `Image` | The image to use for the spray (cannot be combined with `Text`) |
| `Text` | The text to use for the spray (cannot be combined with `Image`) |
| `Display` | The display name of the cosmetic in menus |
| `Description` | The lore of the cosmetic in menus |