{"id":"helixworlds/gatherer-sdk","name":"gatherer-sdk","scope":"helixworlds","platform":"roblox","description":"SDK to integrate and work with the Helixworlds Gatherer API, that is used to create events and track the user interaction.","version":"0.1.0","latest":"0.1.0","versions":["0.0.1","0.1.0"],"license":"Apache-2.0","licenseRating":"safe","licenseCaveats":["Modified files must carry a notice of changes. If the package ships a NOTICE file, its attributions must be preserved.","The package archive does not include its license text; the license is declared in its manifest metadata."],"licenseVerified":false,"dependencies":{},"integrity":"414d05731e207083b590fd7babdfa0eb7e4c74899faaf13e95a8897a1a3f03d8","likes":0,"downloads":0,"install":"forest install helixworlds/gatherer-sdk","url":"https://forest.dev/p/roblox/helixworlds/gatherer-sdk","files":"https://api.forest.dev/ai/package/roblox/helixworlds/gatherer-sdk/files","readme":"# Roblox Gatherer SDK\n\nCurrent version: 0.1.0\n\nThis 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.\n\nVisit 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.\n\nYou 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!\n\nThis package contains 2 ModuleScripts that you can use to connect your game with the Gatherer API seamlessly.\n\n## Installation and Usage\n\n### Setup\n\nClone the repository:\n\n```bash\ngit clone https://github.com/MetaverseGroup/roblox-gatherer-sdk.git\n```\n\nInstall [aftman](https://github.com/LPGhatguy/aftman)\n\nRun:\n\n```\naftman self-install\n```\n\nNote: for mac add the following to ~/.bash_profile\n\n```\nexport PATH=$PATH:~/.aftman/bin\n```\n\nInstall the components\n\n```\naftman install\n```\n\n### VSCode Extension\n\nInstall the Rojo VSCode Extension\n\nFollow this [Rojo Doc (Building your Place)](https://rojo.space/docs/v7/getting-started/new-game/#building-your-place) to Build the package\n\nOpen Roblox Studio and open the build file\n\nFollow this [Rojo Doc (Live Syncing)](https://rojo.space/docs/v7/getting-started/new-game/#live-syncing-into-studio) to make updates and see the changes reflected in realtime inside Roblox Studio (You need the [Rojo Plugin](https://create.roblox.com/store/asset/13916111004/Rojo?externalSource=www) installed)\n\n### Local Server Syncing\n\nInstall the plugin\n\n```\nrojo plugin install\n```\n\n## Development\n\n### Build and Release\n\nBuild Model:\n\n```\nrojo build -o GathererSDK.rbxm\n```\n\n### Code\n\nOpen roblox studio and open a game, or a create a new game.\n\nOpen the rojo plugin under pluings and connect to the local rojo server\n\nEdit the files in VSCode or another IDE.\n\n### Install\n\n[pre-commit](https://pre-commit.com/)\n\n### Pull Requests\n\nCreate a new PR use the ticket number to prepend the PR name\n\n### CI workflows\n\nSee .github/workflows/ci.yaml\n\n### Release\n\nTo create a new release, first create a PR and then add the patch, minor or major label to it depending upon the release updates.\n","readmeTruncated":false}