Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/guribo/udonvehiclesyncsaccflightadapter

Adapter for Plug-and-play vehicle sychnronization replacement for SaccFlightAndVehicles
https://github.com/guribo/udonvehiclesyncsaccflightadapter

adapter udon udonsharp vrchat vrchat-sdk3 vrchat-worlds vrchat-worlds-udon

Last synced: 3 months ago
JSON representation

Adapter for Plug-and-play vehicle sychnronization replacement for SaccFlightAndVehicles

Awesome Lists containing this project

README

        

# Udon Vehicle Synchronization - SaccFlightAndVehicles Adapter

[![Total downloads](https://img.shields.io/github/downloads/Guribo/UdonVehicleSyncSaccFlightAdapter/total?style=flat-square&logo=appveyor)](https://github.com/Guribo/UdonVehicleSyncSaccFlightAdapter/releases)

A plug-and-play replacement for the vehicle synchronization of [SaccFlightAndVehicles](https://github.com/Sacchan-VRC/SaccFlightAndVehicles).

See [UdonVehicleSync](https://github.com/Guribo/UdonVehicleSync) for details.

## Installation

1. Import SaccFlightAndVehicles UnityPackage: https://github.com/Sacchan-VRC/SaccFlightAndVehicles/releases/tag/1.64
2. Install/Add VRChat World SDK 3.7 to your project
3. Install/Add CyanPlayerObjectPool to your project: https://cyanlaser.github.io/CyanPlayerObjectPool/
4. Install/Add TLP UdonVehicleSync SaccFlightAdapter to your project: https://guribo.github.io/TLP/

## Setup

![Setup](.Readme/UVS_Setup.gif)

*Note: All prefabs are in the `Packages` folder so make sure that you select either `All` or `Packages` when searching for them.*

1. Add `TLP_Essentials` prefab to your scene
2. Add `TLP_SyncOrigin` prefab to your scene and verify it is not rotated and at position 0,0,0
3. Add any vehicle prefab to your scene
4. Drag and drop the `TLP_UdonVehicleSync_with_SettingsTweaker_SaccFlightAdapter` onto the vehicle prefab.
5. Open the prefab and adjust the position of the `SettingsTweaker` menu to be easily usable (disable GameObject if not needed).
6. Enter play mode with client sim enabled and verify that there is no related errors on the console.
7. Upload or test with multiple clients to see it in action.

## Known Issues

- Receiving players are currently not receiving the current velocity, it shows zero in cockpits or vehicles
- This also prevents sonic booms from working

## Versioning

This package is versioned using [Semantic Version](https://semver.org/).

The used pattern MAJOR.MINOR.PATCH indicates:

1. MAJOR version: incompatible API changes occurred
- Implication: after updating backup, check and update your scenes/scripts as needed
2. MINOR version: new functionality has been added in a backward compatible manner
- Implication: after updating check and update your usages if needed
3. PATCH version: backward compatible bug fixes were implemented
- Implication: after updating remove potential workarounds you added

## Changelog

All notable changes to this project will be documented in this file.

### [1.2.0] - 2024-09-14

#### 🚀 Features

- Update to UdonVehicleSync 2.2

### [1.1.1] - 2024-06-03

#### ⚙️ Miscellaneous Tasks

- Migrate to UdonUtils 8.2.0

### [1.1.0] - 2024-05-17

#### 🚀 Features

- *(SaccFlightAdapter)* Fix spawn orientation if vehicle was rotated inside its prefab, attempt to improve respawn behaviour, support UVS 2.1.0, fix missing ground material in demo scene

### [1.0.1] - 2024-05-17

#### 📚 Documentation

- *(Readme)* Be a bit more descriptive in installation instructions

#### ⚙️ Miscellaneous Tasks

- Fix typo
- *(Prefab)* Disable debug trails by default, make dynamic send rate stricter to be more likely to send updates when moving slowly

### [1.0.0] - 2024-05-16

#### 🚀 Features

- Add prefabs and demo scene, update readme