# rivet

**Repository Path**: zoujiaqing/rivet

## Basic Information

- **Project Name**: rivet
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: 01-01-Add_BOLT_SKIP_GEN_env_var_for_faster_commands
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-08
- **Last Updated**: 2024-09-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img alt="rivet_logo" src="./media/banner.png">
</p>

<p align="center">
  <i>Managed game servers, matchmaking, and DDoS mitigation that lets you focus on building your game.</i>
</p>

<p align="center">
  <a href="/docs/philosophy/LICENSING.md"><img alt="License Apache-2.0" src="https://img.shields.io/github/license/rivet-gg/rivet?style=flat-square"></a>
  <a href="/docs/processes/VERSIONING.md"><img alt="Calendar versioning" src="https://img.shields.io/badge/calver-YY.MINOR.MICRO-22bfda.svg?style=flat-square"/></a>
  <a href='http://makeapullrequest.com'><img alt='PRs Welcome' src='https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square'/></a>
  <a href="https://github.com/rivet-gg/rivet/graphs/commit-activity"><img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/rivet-gg/rivet?style=flat-square"/></a>
  <a href="https://github.com/rivet-gg/rivet/issues"><img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/rivet-gg/rivet?style=flat-square"/></a>
</p>

<p align="center">
  <a href="https://rivet.gg/">Home</a> - <a href="https://rivet.gg/docs">Docs</a> - <a href="https://twitter.com/rivet_gg">Twitter</a> - <a href="https://discord.gg/BG2vqsJczH">Discord</a>
</p>

## 👾 Features

-   Everything is accessible from an easy to use [GUI, CLI, or API](https://rivet.gg/docs/general/gui-cli-api)
-   [Serverless Lobbies](https://rivet.gg/docs/serverless-lobbies) for auto-scaling game lobbies
-   [Flexible matchmaker](https://rivet.gg/docs/matchmaker) for placing players in lobbies with no wait times
-   [CDN](https://rivet.gg/docs/cdn) for hosting assets and webpages with a custom domain or provided rivet.game subdomain
-   [Game Guard](https://rivet.gg/docs/serverless-lobbies/concepts/game-guard) for DDoS mitigation and managed WebSocket SSL, TCP+TLS, and UDP
-   Streamlined DevOps for teams
-   Unified logging & monitoring & analytics
-   No downtime deploys with easy rollbacks

<p align="center">
  <img alt="rivet_screenshot" src="./media/splash_screenshot.png">
</p>

## 🚀 Getting Started

### Rivet Cloud

[Rivet Cloud](https://rivet.gg) is the fastest way to get your game up and running. Sign up at [rivet.gg](https://rivet.gg) and get a free game server.

### Self-hosting

See the [setup guide](/docs/getting_started/DEVELOPMENT.md) to develop & deploy Rivet yourself.

## 📐 Architecture

Below is a simplified architecture diagram of a Rivet cluster.

![Architecture](/media/simplified_architecture.png)

## 📖 Documentation Overview

> **Looking for documentation on building a game with Rivet?**
>
> Visit our [documentation for game developers](https://rivet.gg/docs)!

**Getting Started**

-   [Project Structure](/docs/getting_started/PROJECT_STRUCTURE.md)
-   [Developing on Rivet](/docs/getting_started/DEVELOPMENT.md)
-   [Debugging Rivet](/docs/getting_started/DEBUGGING.md)
-   [Services](/docs/getting_started/SERVICES.md)
-   [Error Handling](/docs/libraries/chirp/ERROR_HANDLING.md)

**Philosophy**

-   [Why open source](/docs/philosophy/WHY_OPEN_SOURCE.md)

**Architecture**

-   [Software Bill of Materials](/docs/infrastructure/SBOM.md)

**About**

-   [Notable missing features](/docs/about/MISSING_FEATURES.md)

## We're hiring!

We're a team of scrappy engineers willing to get our hands dirty with everything from Linux internals, niche game engines, designs that don't look like [this](https://www.linears.art/), and god-tier developer experiences. If you prefer reading the source instead of documentation, love hacking on games in your free time, and have a healthy dose of anarchy in you, come [join us!](https://rivet-gg.notion.site/Job-Board-eed66f2eab2b4d7ea3e21ccd63b22efe?pvs=4)