Installation & Setup

Realistic Analytics is distributed as a ready-to-use Roblox model (.rbxm / .rbxmx) or as source code for Rojo-based workflows.

---

Recommended: Download from GitHub Releases

The quickest and easiest way to install Realistic Analytics into any Roblox game is to download the latest pre-compiled release from GitHub:

👉 Download Latest Release on GitHub

Installation Steps

1. Navigate to Releases on the GitHub repository.
2. Under the latest release tag (e.g. v1.0.0), download either asset:
   • realistic-analytics-vX.Y.Z.rbxm (Recommended): Roblox Binary Model format. Optimized, fast loading, and ideal for standard Studio development.
   • realistic-analytics-vX.Y.Z.rbxmx: Roblox XML Model format. Human-readable and ideal for diffing in version-controlled projects.
3. Open your project in Roblox Studio.
4. Drag and drop the downloaded file directly into ReplicatedStorage.
5. Ensure the imported model/ModuleScript is named AnalyticsModule.

Explorer
├── ReplicatedStorage
│   └── AnalyticsModule  <-- Drop the downloaded .rbxm here
├── ServerScriptService
└── StarterPlayer
    └── StarterPlayerScripts

You are now ready to initialize the module in your server and client scripts! Follow the Quickstart Guide to begin tracking metrics.

---

Alternative: Rojo Project Integration

If your Roblox game is managed with Rojo, you can include Realistic Analytics directly in your project configuration without manual model files.

1. Add as a Submodule or Subdirectory

Clone or add Realistic Analytics as a Git submodule into your repository:

git submodule add https://github.com/iirealisticdev/realistic-analytics.git vendor/realistic-analytics

2. Map into default.project.json

Add the module path into your project’s ReplicatedStorage definition:

{
  "name": "MyRobloxGame",
  "tree": {
    "$className": "DataModel",
    "ReplicatedStorage": {
      "$className": "ReplicatedStorage",
      "AnalyticsModule": {
        "$path": "vendor/realistic-analytics/src/AnalyticsModule"
      }
    }
  }
}

When you start rojo serve, the library will automatically synchronize into ReplicatedStorage.AnalyticsModule.

---

Alternative: Building from Source

If you want to modify the source code or build custom distribution models locally:

Prerequisites

• Aftman or Rojo CLI (v7.4+)

Build Commands

# Clone the repository
git clone https://github.com/iirealisticdev/realistic-analytics.git
cd realistic-analytics

# Build binary model (.rbxm)
rojo build model.project.json -o realistic-analytics.rbxm

# Build XML model (.rbxmx)
rojo build model.project.json -o realistic-analytics.rbxmx

---

Automated CI/CD Releases

Every version tag (e.g. v1.0.0) pushed to the repository automatically triggers our GitHub Actions build pipeline. The workflow:

1. Runs strict Luau static analysis and syntax validation.
2. Compiles standalone .rbxm and .rbxmx distribution models using Rojo.
3. Publishes a new release to GitHub Releases with compiled models attached.