Skip to content

Commit de63d64

Browse files
committed
feat: Cleanup readme for initial release (#6)
1 parent 0b0482e commit de63d64

3 files changed

Lines changed: 76 additions & 7 deletions

File tree

Lines changed: 9 additions & 0 deletions
Loading
Lines changed: 9 additions & 0 deletions
Loading

README.md

Lines changed: 58 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,65 @@
1-
# Unity Plugin (Coming Soon)
1+
<p align="center">
2+
<picture>
3+
<source media="(prefers-color-scheme: dark)" srcset="Assets/Rivet/Editor/Images/icon-text-white.svg">
4+
<img src="Assets/Rivet/Editor/Images/icon-text-black.svg">
5+
</picture>
6+
</p>
7+
<h1 align="center">Rivet Unity Plugin</h1>
8+
<p align="center">
9+
<a href="https://rivet.gg/discord"><img src="https://img.shields.io/discord/822914074136018994"></a>
10+
</p>
211

3-
Placeholder repository for the Rivet Unity plugin coming soon. [Join our Discord](https://discord.gg/aXYfyNxYVn) to get access to the Unity plugin.
12+
Source for the Rivet Unity plugin. [Join our
13+
Discord](https://discord.gg/aXYfyNxYVn) to get help. Check out our [Unity
14+
FishNet
15+
example](https://github.com/rivet-gg/examples/tree/main/unity/tanks-fishnet) to
16+
get started today.
417

5-
See also our WIP [Unity FishNet example](https://github.com/rivet-gg/example-tanks-unity-fishnet) to get started today.
18+
## 📦 Installation
619

7-
## Installation
20+
You can install the Rivet Unity plugin in a couple ways:
821

9-
_Coming soon_
22+
- **Import a Unity Asset**: Go to the latest release on the [releases
23+
page](https://github.com/rivet-gg/plugin-unity/releases)
24+
- **Unity Package**: Use this Git URL in the Package Manager:
25+
https://github.com/rivet-gg/plugin-unity.git?path=Assets/Rivet
26+
- **Manual Install**: Clone this repository and copy the `Assets/Rivet` folder
27+
into your Unity project
28+
- **Unity Asset Store**: Coming soon!
1029

11-
## Getting started
30+
## 🚀 Getting started
1231

13-
[Getting started guide](https://rivet.gg/learn/unity)
32+
Head over to our [Learning Center](https://rivet.gg/learn/godot) to get started
33+
with Rivet and Godot.
1434

35+
## 🧐 Features
36+
37+
### Link your game with Rivet
38+
39+
One click and your game is connected! Linking your game with Rivet gives you
40+
one-click deployments to production, easy playtesting setup, and ways to
41+
configure your game's hosting and matchmaking.
42+
43+
### Deploy your game
44+
45+
Without the use of any command line commands, Rivet plugin lets you deploy your
46+
game server in no time.
47+
48+
### Manage your tokens
49+
50+
Rivet lets you test your multiplayer games in multiple ways. Don't worry about
51+
using any complicated commands, this plugin keeps you covered.
52+
53+
_and much more coming soon!_
54+
55+
## 🏗️ Contributing
56+
57+
1. Look for any issue that describes something that needs to be done - or, if
58+
you're willing to add a new feature, create a new issue with an appropriate
59+
description.
60+
- You can follow [Rivet RFCs](https://github.com/rivet-gg/rfcs) if you want
61+
to be up to date with upcoming features.
62+
2. Submit your pull request.
63+
3. Rivet team will review your changes.
64+
4. Don't forget to join [Rivet's Discord](https://rivet.gg/discord) to hang out
65+
with the devs, or to pairprogram together!

0 commit comments

Comments
 (0)