npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rbxts/gameanalytics

v2.2.3-ts.1

Published

The GameAnalytics SDK for roblox-ts

Downloads

560

Readme

TS typings for the GameAnalytics Roblox SDK.

NPM

Run npm i @rbxts/gameanalytics in your project directory.

Unlike the normal Luau Roblox SDK, this package does not require moving scripts around in different DataModel locations.

In a server script, run GameAnalytics.initialize

import { GameAnalytics } from "@rbxts/gameanalytics";

GameAnalytics.initialize({
	gameKey: "<GAME KEY HERE>",
	secretKey: "<SECRET KEY HERE>",
	availableResourceCurrencies = ["Coins"],
	...
});

or initializeServer, which uses a predefined configuration:

import { initializeServer } from "@rbxts/gameanalytics";

initializeServer("<GAME KEY HERE>", "<SECRET KEY HERE>");
{
	build: "0.1",

	enableInfoLog: true,
	enableVerboseLog: true,

	// debug is enabled in Studio by default
	enableDebugLog: undefined,

	automaticSendBusinessEvents: true,
	reportErrors: true,

	availableCustomDimensions01: [],
	availableCustomDimensions02: [],
	availableCustomDimensions03: [],
	availableResourceCurrencies: [],
	availableResourceItemTypes: [],
	availableGamepasses: []
}

After initialization, you can now fire analytics events, such as GameAnalytics.addDesignEvent, GameAnalytics.addProgressionEvent, GameAnalytics.addResourceEvent. It's strongly recommended that you read the Event Tracking guide for the usage of these functions.

In a client script, run initializeClient:

import { initializeClient } from "@rbxts/gameanalytics";

initializeClient();

Retrieving data from the server on the client side (A/B experiment data, Remote Configs), is not implemented in the GameAnalytics SDK. If you want to use one of these features on the client side, you will have to create RemoteEvents manually.

For custom usernames, implementing this such as in the guide (on the client side) is not recommended for security reasons.

const getUsername = (player: Player) => {
  // don't actually use DisplayNames
  return player.DisplayName;
};

GameAnalytics.addDesignEvent(getUsername(player), {
  eventId: "testEvent",
});

If you would like to contribute to the GameAnalytics Roblox SDK, please file Pull Requests and Issues in its GitHub repository, and not in the repository of this package. The types here will reflect the most recent release of the Luau code.