Roblox Gatherer SDK

Current version: 0.1.0

This package was developed by MetaverseGroup and should be used to track events and logs inside your Roblox games. It was created to integrate with the Helixworlds System, so you can visit app.helixworlds.io to see the gathered analytics.

Visit the website, create an account, an organization, your game, and get the credentials to start tracking your users and getting knowledge to improve and make your app more successful.

You can also create custom events and track them using this package, being able to measure different kinds of actions and get good insights about your games and items!

This package contains 2 ModuleScripts that you can use to connect your game with the Gatherer API seamlessly.

Installation and Usage

Setup

Clone the repository:

git clone https://github.com/MetaverseGroup/roblox-gatherer-sdk.git

Install aftman

Run:

aftman self-install

Note: for mac add the following to ~/.bash_profile

export PATH=$PATH:~/.aftman/bin

Install the components

aftman install

VSCode Extension

Install the Rojo VSCode Extension

Follow this Rojo Doc (Building your Place) to Build the package

Open Roblox Studio and open the build file

Follow this Rojo Doc (Live Syncing) to make updates and see the changes reflected in realtime inside Roblox Studio (You need the Rojo Plugin installed)

Local Server Syncing

Install the plugin

rojo plugin install

Development

Build and Release

Build Model:

rojo build -o GathererSDK.rbxm

Code

Open roblox studio and open a game, or a create a new game.

Open the rojo plugin under pluings and connect to the local rojo server

Edit the files in VSCode or another IDE.

Install

pre-commit

Pull Requests

Create a new PR use the ticket number to prepend the PR name

CI workflows

See .github/workflows/ci.yaml

Release

To create a new release, first create a PR and then add the patch, minor or major label to it depending upon the release updates.