Repository Structure
To keep repositories clean and organized, OpenMods requires all mod-related metadata and assets to be placed inside a dedicated .openmods folder at the root of your repository.
folder The .openmods Folder
Here is the standard layout for your mod repository:
your-repo/
├── .openmods/
│ ├── install.json // (Optional) Instructions for OpenModsManager installation
│ ├── media/ // (Optional) Gallery media (png, jpg, mp4, etc.)
│ ├── MEDIA.md // (Optional) Curate the gallery from the repo
│ ├── LINKS.md // (Optional) External links sidebar
│ └── FAQ.md // (Optional) Frequently asked questions
├── README.md // Standard GitHub readme └── * // Your actual mod source code
├── .openmods/
│ ├── install.json // (Optional) Instructions for OpenModsManager installation
│ ├── media/ // (Optional) Gallery media (png, jpg, mp4, etc.)
│ ├── MEDIA.md // (Optional) Curate the gallery from the repo
│ ├── LINKS.md // (Optional) External links sidebar
│ └── FAQ.md // (Optional) Frequently asked questions
├── README.md // Standard GitHub readme └── * // Your actual mod source code
lightbulb
Why this structure?
This separation ensures your root directory isn't cluttered with OpenMods specific files. When OpenMods syncing occurs, it will automatically look inside the .openmods directory for your assets and metadata if it exists, falling back to the root if not found.
Ready to distribute your mods?
Join hundreds of other developers using OpenMods to deliver their creations to players faster.