Quickstart Guide

This guide will get you up in running within minutes.

Prerequisites

1. You must be working within a roblox-ts project. (Preferably the plugin template) Learn More → (opens in a new tab)

1. Install with NPM

You can install the package using NPM

npm i @rbxts/comet

2. Create a system

Create a new file within your project. Below is a bare-bones example system.

import { System, onInit } from "@rbxts/comet";
 
export class MySystem extends System implements onInit {
	onInit(): void {
		print("hello, world!")
	}
}

2. Server script setup

Import your system into your main file, then input the following three lines.

import { comet } from "@rbxts/comet";
import { MySystem } from "./system";
 
comet.createApp(plugin, "MyAwesomeApp");
comet.registerSystem(MySystem);
comet.launch();

Ta-da!

That is all it takes to get comet going. You are ready to start making a plugin!

Example Plugin

To see comet in action, check out the Example Plugin (opens in a new tab).