Understanding The Project Structure

Introduction

To publish things to the repository, maintainers should understand to follow a specific format in specific locations to keep a consistent organizational structure.

Project Structure Overview

The following is a graph that represents the repository structure.

.github
├── workflows
├── scripts
└── ISSUE_TEMPLATE
production
├── [map].diff
└── keepalive
staging
├── [map].diff
└── keepalive
README.md

Everything encapsulated in square brackets [like this] means there's one or more of the same structure with a different name.

.github

GitHub specific configurations for repository functions.

workflows

CI/CD entry points for GitHub.

scripts

Scripts for CI/CD.

ISSUE_TEMPLATE

GitHub issue templates for ease of use.

staging

Consists of ready-to-go maps diffs with fixes. Maps that are not ready for production should be kept in a fork of the repository until done. (Make a pull request when done.)

Using base .rbxl or other Roblox model file formats would be too big for the repository and would reach the maximum repository size limit very fast. (soon) Users can request the roblox model directly with an applied diff and upload said file to the Roblox platform where it can be accessed.

production

Consists of map fixes that are implemented in the production game.