Mods Registry
Submission Guidelines
If you are a [mod developer] and would like to submit your mod, please follow these guidelines:
-
Mod requirements:
- Your mod must be compatible with Zen Browser.
- Your mod must be open-source.
- Your mod must not contain any malicious code.
- Your mod must not violate any copyright laws.
-
Mod Validation:
- Your mod's name must be unique and less than
25
characters. - Your mod's description must be less than
100
characters. - Your mod's screenshot must be a
PNG
with a size of600x400
(it can be resized after upload). - Your mod must contain a valid
README
describing the mod and how to use it. - If your mod has any preferences values, they must be set in the
preferences
text area as aJSON
object.- See how preferences work here.
- Your mod's name must be unique and less than
-
Mod Submission:
- To submit your mod, please create an issue here
- Fill out the template with the required information.
- Once you have submitted your mod, it will be analyzed by a bot and a pull request will be created.
- If your mod is approved, it will be added to the Mods Registry.
-
Mod Update:
- If you would like to update your mod, please create an issue here
- Please explain the changes you have made.
-
Mod Removal:
- The mod may be removed if it is no longer being actively maintained and it's causing issues for users
- The mod may be removed at the dev team's discretion for any reason, including but not limited to misalignment with the project’s scope, aesthetics, or goals.
- The mod may be removed if it causes compatibility issues, disrupts user experience, or introduces unresolved bugs.
Mods are automatically updated and generated by the bot. If your mod is not approved, you will receive a message with the reason why it was not approved.