Skip to content

Home

Jump to bottom
Ethan edited this page Sep 27, 2025 · 6 revisions

OMGG's Logo

OMGG Package Template

Welcome to the OMGG Package Template wiki.

This repository serves as the base template for creating new Unity packages under the OMGG organization. It provides a ready-to-use structure, development standards, and automation workflows so that every new package is consistent, maintainable, and production-ready.

🎯 Purpose

The goal of this template is to:

  • Standardize package structure across the OMGG ecosystem.
  • Reduce setup time for new repositories.
  • Enforce best practices for coding, documentation, and version control.
  • Integrate package exporting through GitHub Actions using a shared export script.

📦 What’s Included

  • Pre-configured Unity package layout.
  • Exporter script (Exporter.cs) inside <package-name>Assets/Editor:
    • Defines the Exporter.ExportPackage method used by CI/CD workflows.
    • Ensures all relevant files are exported, while ignoring tests and unwanted content.
  • GitHub Actions for:
    • Unity license validity checking.
    • Package exporting via Exporter.ExportPackage.
  • Templates for:
    • Pull Requests.
    • Issues.
  • Basic README structure.
  • .gitignore and other default configurations.
  • Project renaming script (rename.ps1) to quickly update project name and identifiers after cloning the template.
  • License files:
    • LICENSE.md – Main project license.
    • ASSET_LICENSE.md – Asset-specific license and usage terms.

📚 Documentation Index

This wiki contains all the documentation you need to start working with this template.

Page Description
Development Standards Coding conventions, Pull Request templates, and issue guidelines.
Creating a New Package Step-by-step guide to start a new package from this template.
CI/CD Workflows How package building and exporting work with Exporter.cs.
Package Structure Explanation of the Unity package layout used in this template.

🌐 Related Repositories

💡 How to Use This Template

  1. Follow the instructions in Creating a New Repository.
  2. Customize your package content while keeping the core structure intact.
  3. Maintain consistency with the Development Standards.
  4. Push on the main branch -> the CI/CD workflow will automatically export your .unitypackage.

Note: Any package created from this template should follow OMGG’s naming conventions and repository guidelines.

Clone this wiki locally