Start Here
Getting Started
Quartz is being built around its own package system. A Quartz mod should be easy for the launcher to read, validate, install, test, and eventually submit for review.
1. Create your mod folder
Keep your files organized so Quartz can understand what belongs to the package.
2. Add a manifest
The manifest tells Quartz the mod name, ID, version, author, engine, entry file, and package info.
3. Add your payload files
Your payload contains the actual files your mod needs to run.
4. Validate before sharing
Before submitting, the package should install correctly and avoid missing files or broken metadata.
Submission Rules
Mod Submission Rules
- Mods must be packaged correctly and include the required files.
- Mods must have a clear name, ID, version, author, and description.
- Mods must not include malware, token grabbers, suspicious files, or unsafe behavior.
- Mods must not steal code, assets, icons, or work from other creators.
- Mods should be reasonably stable and ready for testing or public use.
- Mods should not be spam, duplicated packages, or intentionally misleading.
- Mods must follow Quartz community rules and submission rules.
Package Format
Quartz Package Format
Quartz packages use a manifest-based format so the launcher can read important information before installing or testing the mod.
{
"format": "quartz.package",
"id": "creator.mod-name",
"name": "Example Mod",
"version": "1.0.0",
"author": "CreatorName",
"engine": "quartz-native",
"entry": "payload/main.js",
"description": "Short description of what the mod does."
}Packaging
How to Package a Mod
- Create a clean folder for your mod.
- Add your manifest file.
- Add your payload folder and required mod files.
- Include any icons, assets, or extra files your mod needs.
- Build or export the package into the Quartz package format.
- Test the package locally before submitting it.
Review Process
How Mod Review Works
Mod review is meant to keep Quartz safe, clean, and useful. Reviews may check if the package installs, if the manifest is valid, if required files exist, and if the mod follows the submission rules.
Install Check
The package should install without missing files or broken paths.
Manifest Check
The package should include valid metadata so Quartz can read it correctly.
Safety Check
The package should not include harmful files, suspicious behavior, or unsafe code.
Quality Check
The mod should be clear, useful, credited properly, and not spam or duplicate content.
Declined Mods
Why Mods Get Declined
Common reasons a mod may be declined
- The package is broken or cannot install correctly.
- The manifest is missing, invalid, or has unclear information.
- Required files are missing from the package.
- The mod crashes Quartz or Geometry Dash during testing.
- The mod includes unsafe code, suspicious behavior, or harmful files.
- The mod uses stolen work, stolen assets, or does not credit required creators.
- The description is misleading, empty, or does not explain what the mod does.
- The mod is spam, duplicated, low-effort, or not ready for public release.
- The mod breaks Quartz community rules or submission rules.
A decline does not always mean the mod is banned forever. Most of the time it just means something needs to be fixed before the mod is ready. Developers can fix the issue and resubmit when ready.
Developer Tools
Future Dev Tools
Quartz dev tools are planned to make mod creation easier for new developers and cleaner for experienced ones.
Create New Mod
Start a new Quartz-native mod from a beginner-friendly template.
Validate Package
Check a package for missing files, invalid manifest data, and common mistakes.
Test Install
Install a local package into Quartz so creators can test before sharing.
Export Logs
Export useful logs when something breaks so bugs are easier to fix.