Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Guribo committed Nov 16, 2023
1 parent f1baade commit 235c2b2
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,35 @@ Please note that there is no explicit documentation available. The code is chang
- VRChat Creator Companion
- VRC World SDK
- [CyanPlayerObjectPool](https://cyanlaser.github.io/CyanPlayerObjectPool/)


## 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

## 2.0.0 Change Notes

### Additions
* Add `ImageDownloader`
* Add `GetMaster` from list of players helper function to `VRCPlayerUtils`
* Add optional position smoothing to `PlayerFollower`
* Add timestamp backlog of received Deserializations and `PredictionReduction` parameter to `TlpAccurateSyncBehaviour`
* Add UI prefabs for runtime test system
* Add demo scene for new runtime test system
### Fixes
- Improve error handling on `PackageExporter`
- Fix `TrackingDataFollower` crashing if local player is not yet valid
### Deletions
- Remove `FormerlySerializedAs` entries from `TlpLogger`
### Other
- Rename `useLocalPlayerByDefault` to `UseLocalPlayerByDefault` in `ObjectSpawner`
- Complete overhaul of runtime test system

0 comments on commit 235c2b2

Please sign in to comment.