Manifest.json Overview - Opera GX Mods
Learn about the structure and fields in the manifest.json file, the core configuration for Opera GX mods.
The manifest.json file is the backbone of your Opera GX mod. It defines the mod’s structure, assets, and functionalities.
📝 What is manifest.json?
The manifest.json is a JSON configuration file that:
- Describes your mod's metadata.
- Declares assets like wallpapers, themes, sounds, shaders, and effects.
- Specifies how your mod interacts with Opera GX Browser.
🛠️ Key Sections
1. Metadata (Basic Info)
This section contains basic details about your mod:
manifest.json
{
"name": "My Cool Mod",
"version": "1.0.0",
"description": "A description of what this mod does.",
"developer": {
"name": "Your Name"
},
"manifest_version": 3
}
Key Properties:
| Key | Description |
|---|---|
"name" | Display name of your mod. |
"version" | Mod version number (update when modifying). |
"description" | A short summary of your mod's purpose. |
"developer" | Your name or developer alias. |
"manifest_version" | Must be 3 for Opera GX mods. |
Tip: Always update "version" when modifying your mod to avoid caching issues.
2. Mod Configuration
This section contains all the assets and settings.
manifest.json
{
"mod": {
"license": "license.txt",
"schema_version": 2,
"payload": {
// Your assets go here
}
}
}
Key Properties:
| Property | Purpose |
|---|---|
"license" | Specifies the mod's license file. |
"schema_version" | Ensures compatibility with Opera GX. |
"payload" | Contains all mod assets. |
Important: Ensure all asset paths are correct and included in your mod package.
🧰 Best Practices
- Validate Your JSON: Use a JSON Validator to check for errors.
- Use Relative Paths: Reference assets from your mod’s root directory.
- Keep It Organized: Store assets in well-structured folders.
- Test Your Mod: Load it in Opera GX Mods Extention before publishing.
📖 Learn More
- 🔍 Check the GX Mods Reference Docs.
- 🎨 Explore our Mods Interface section for advanced UI customizations.
- 🎵 Discover Mods Sounds section for audio enhancements.
- ✨ Learn about Mods Effects section for visual and interactive improvements.