Setup

Project Format

Source Management Only

irisCORE is only used for managing source files, such as scripts, modules, and packages. All 3D world-related things and interface objects should be managed from within Roblox Studio.

.
└── DataModel/
    ├── ReplicatedStorage/
    │   └── irisSHARED/
    │       └── Source/
    │           ├── Modules
    │           ├── Packages # Read Only (Package manager)
    │           └── Services # Read Only
    ├── ServerScriptService/
    │   └── irisSERVER/
    │       └── Source/
    │           ├── Modules
    │           ├── Packages # Read Only (Package manager)
    │           └── Scripts
    └── StarterPlayer/
        └── StarterPlayerScripts/
            └── irisCLIENT/
                └── Source/
                    ├── Modules
                    └── Scripts

Definitions

Module

A collection of functions and variables that can be included in other scripts. These are written by the developer and not imported using a package manager.

Package

A collection of modules that are imported using a package manager. These should not be manually inserted or modified. Packages should never make references to game modules or services.

Services

Systems built into irisCORE and Roblox that provide functionality to other scripts. They should not be modified by the developer.

Accessing irisCORE

The Core is the most important part of the framework. It provides access to all services, runs scripts, contains modules, packages, and game assets.

Tip

The Core will always be finished loading before scripts run. Both the Source folder and all services will exist and be ready for use immediately.

local irisCORE = shared

See API for more information.