https://github.com/rivet-gg/plugin-unreal

Plugin for Rivet + Unreal Engine 5
https://github.com/rivet-gg/plugin-unreal

multiplayer server udp unreal unreal-engine unreal-engine-5

Last synced: 1 day ago
JSON representation

Plugin for Rivet + Unreal Engine 5

• Host: GitHub
• URL: https://github.com/rivet-gg/plugin-unreal
• Owner: rivet-gg
• License: apache-2.0
• Created: 2023-07-17T05:40:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-26T22:19:16.000Z (9 months ago)
• Last Synced: 2024-02-27T22:35:31.103Z (9 months ago)
• Topics: multiplayer, server, udp, unreal, unreal-engine, unreal-engine-5
• Language: C++
• Homepage: https://rivet.gg/learn/unreal
• Size: 54.7 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Unreal Engine 5 Plugin

_Tested with Unreal Engine 5.2.1._

_Has not been tested with Unreal Engine 4._

## Installation

### Method 1: Initialize project with the Rivet CLI (recommended)

This method will also configure your Rivet project. 

1. Install the [Rivet CLI](https://github.com/rivet-gg/cli)

2. Run `rivet init --unreal` in the root of your project

3. The CLI will prompt you to configure your project & install the plugin

4. Restart the Unreal editor

### Method 2: Install with Rivet CLI

This method can be used to upgrade an existing plugin installation.

1. Install the [Rivet CLI](https://github.com/rivet-gg/cli)

2. Run `rivet unreal install-plugin` in the root of your project

3. Restart the Unreal editor

### Method 3: Copy manually

1. Create a `Plugins` folder in the root of your project (it may already exist)

2. Copy the `Plugins/Rivet/` folder from this repository to the `Plugins/Rivet/` folder in your project

3. Restart the Unreal editor

## Getting started

[Getting started guide](https://rivet.gg/learn/unreal)