Rivet
ActorCore is still pre-v1.0. Please help us by report bugs on GitHub Issues!
Create New Project
Create Project with CLI
Run this command:
Follow the prompts:
- Where would you like to create your project? - Choose your project directory
- To which platform would you like to deploy? - Select Rivet
- Which template would you like to use? - Select counter, or your template of choice
The CLI will set up your project and install all dependencies automatically.
Deploy to Rivet
Deploy your project to Rivet with:
This will prompt you to:
- Login to Rivet and create a project
- Select an environment
After successful deployment, you’ll receive important URLs:
- Actor Manager URL: Used for client connections to your actors
- Actors Dashboard: Manage deployed actors and view their status
- Builds Dashboard: Monitor build history and deployment logs
Make sure to save your Actor Manager URL as you’ll need it to connect from your client code.
Test
Update tests/client.ts
to use the deployed endpoint. Replace the local endpoint in client.ts with your Rivet deployment URL:
Then run the client:
Run this again to see the state update as the actor maintains its state between calls.
Monitor
Monitor your actors, builds, and performance through the Rivet Hub using the links provided in the deployment output:
- Actors: View and manage your deployed actors
- Builds: Review build history and logs
- Actor Manager: Access the actor manager endpoint for direct connections
Visit the Rivet Dashboard to view your project.
Accessing Rivet Context
Rivet’s ActorContext
can be accessed from createVars
.
Available Regions
Rivet supports deploying your actors to multiple regions automatically. You can specify region preferences in your Rivet project settings in the Rivet Hub.
See available regions here.