Configuration Overview
Configuration Overview
Section titled “Configuration Overview”Glamour uses a JSON-based configuration system that makes it easy to customize particle effects without modifying code.
Configuration Directory Structure
Section titled “Configuration Directory Structure”All configuration files are stored in config/glamour/:
config/glamour/├── particles/ # Pokemon sendout/ambient particles│ ├── confetti_burst.json│ ├── sparkle_aura.json│ └── ...├── persistent_particles/ # Condition-based persistent particles│ ├── shiny_sparkle.json│ ├── legendary_aura.json│ └── ...└── config.json # Main mod configurationMain Configuration File
Section titled “Main Configuration File”config/glamour/config.json controls mod-wide settings:
{ "debug": false, "database": { "type": "sqlite", "path": "glamour_data.db" }, "particleSystem": { "maxRenderDistance": 32, "defaultInterval": 100 }}Main Config Options
Section titled “Main Config Options”- debug: Enable debug logging
- database: Database configuration for state persistence
- particleSystem: Global particle system settings
Particle Configuration Files
Section titled “Particle Configuration Files”Particle configurations are split into two types:
1. Regular Particles (particles/)
Section titled “1. Regular Particles (particles/)”These are manually applied particles that players can select through the GUI or commands.
Structure:
{ "id": "confetti_burst", "displayName": "Confetti Burst", "description": "Celebratory confetti explosion on sendout", "type": "SENDOUT", "particleResourceId": "confetti", "category": "celebration", "rarity": "COMMON", "settings": { "intervalTicks": 100, "delayTicks": 60, "durationTicks": 20 }}2. Persistent Particles (persistent_particles/)
Section titled “2. Persistent Particles (persistent_particles/)”These are condition-based particles that automatically apply when conditions are met.
Structure:
{ "id": "shiny_sparkle", "particleResourceId": "sparkle", "priority": 100, "settings": { "intervalTicks": 40, "durationTicks": 10, "particleCount": 3, "radius": 1.0, "followEntity": true, "maxDistance": 32 }, "conditions": { "isShiny": true }}Configuration Fields Explained
Section titled “Configuration Fields Explained”Common Fields
Section titled “Common Fields”| Field | Type | Description |
|---|---|---|
id | String | Unique identifier for the particle effect |
particleResourceId | String | Cobblemon snowstorm particle ID |
settings | Object | Particle behavior settings |
Particle Types
Section titled “Particle Types”- SENDOUT: Plays when Pokemon is sent out from Pokeball
- AMBIENT: Continuously plays while Pokemon is out
Rarity Levels
Section titled “Rarity Levels”Rarity affects GUI sorting and can be used for permissions:
COMMON- Basic particles available to allUNCOMMON- Slightly rare effectsRARE- Moderately rare effectsEPIC- Very rare effectsLEGENDARY- Extremely rare effectsMYTHICAL- The rarest effects
Particle Settings
Section titled “Particle Settings”| Setting | Description | Default |
|---|---|---|
intervalTicks | Ticks between particle spawns | 100 |
delayTicks | Delay before first spawn | 0 |
durationTicks | How long particles last | 20 |
particleCount | Number of particles per spawn | 1 |
radius | Spawn radius around entity | 1.0 |
followEntity | Attach to entity vs world position | true |
maxDistance | Max render distance in blocks | 32 |
Categories
Section titled “Categories”Categories help organize particles in the GUI. Common categories include:
celebration- Party and celebratory effectselemental- Fire, water, electric, etc.magical- Mystical and arcane effectsnature- Plants, flowers, leavescosmic- Stars, galaxies, space-themedseasonal- Holiday and seasonal effects
You can create custom categories by simply using a new category name in your configs.
Reloading Configuration
Section titled “Reloading Configuration”After editing configuration files, reload them without restarting:
/particles reloadOr for persistent particles:
/persistentparticles reloadDefault Configurations
Section titled “Default Configurations”On first launch, Glamour creates example configurations. You can:
- Edit these examples to customize them
- Delete examples you don’t want
- Create new files following the same structure
Configuration Best Practices
Section titled “Configuration Best Practices”- Unique IDs: Use descriptive, unique IDs for each particle
- Test Values: Start with conservative interval/duration values
- Performance: Higher particle counts and shorter intervals impact performance
- Permissions: Match category/rarity structure to your permission system
- Backup: Keep backups of working configurations before experimenting