Rivet Actor

Rivet Actors have built-in RPC, state, and events — the easiest way to build modern applications.

Getting Started

• Setup Guide
• Documentation
• Examples

Usage

Make sure you've installed the Rivet CLI.

# Create project
rivet init

# Deploy actor
rivet deploy

See the setup guide for more information.

Example

import { Actor } from "@rivet-gg/actor";
import type { Rpc } from "@rivet-gg/actor";

// Durable state for the counter (https://rivet.gg/docs/state)
interface State {
	count: number;
}

export default class Counter extends Actor<State> {
	// Create the initial state when the actor is first created (https://rivet.gg/docs/state)
	override _onInitialize(): State {
		return { count: 0 };
	}

	// Listen for state changes (https://rivet.gg/docs/lifecycle)
	override _onStateChange(newState: State): void | Promise<void> {
		// Broadcast a state update event to all clients (https://rivet.gg/docs/events)
		this._broadcast("count", newState.count);
	}

	// Expose a remote procedure call for clients to update the count (https://rivet.gg/docs/rpc)
	increment(_rpc: Rpc<Counter>, count: number): number {
		this._state.count += count;
		return this._state.count;
	}
}

Related Packages

• Actor Client SDK (@rivet-gg/actor-client)

Community & Support

• Join our Discord
• Follow us on X
• Follow us on Bluesky
• File bug reports in GitHub Issues
• Post questions & ideas in GitHub Discussions

License

Apache 2.0