Skip to content

Commit 7183936

Browse files
committed
feat: add documentation for avatar control sample
1 parent 9d2fb6b commit 7183936

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

README.md

+22-8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Ready Player Me Unity SDK - Netcode Support
22

3-
This provides support for loading RPM avatar in a multiplayer application using [Netcode](https://unity.com/products/netcode) and [Ready Player Me Unity SDK](https://github.com/readyplayerme/rpm-unity-sdk-core). It also provides a working sample of a multiplayer.
4-
This can be used as a reference for anyone wanting to use Ready Player Me Unity SDK to create a multiplayer using Unity Netcode.
5-
The sample showcases a rudimentary PvP fighting game (e.g., Street Fighter, Tekken).
3+
This provides support for loading RPM avatar in a multiplayer application using [Netcode](https://unity.com/products/netcode) and [Ready Player Me Unity SDK](https://github.com/readyplayerme/rpm-unity-sdk-core). This can be used as a reference for anyone wanting to use Ready Player Me Unity SDK to create a multiplayer using Unity Netcode. It also provides a working samples:
4+
- Avatar Control - It showcases how to have a simple controls for avatar in a multiplayer game.
5+
- Basic Fighting Game - It showcases a rudimentary PvP fighting game (e.g., Street Fighter, Tekken).
66

7-
> Note: This sample doesn't contain a completed game but rather a working example of a very basic multiplayer fighting game.
7+
> Note: These sample doesn't contain a completed games but rather a working example of a very basic multiplayer.
88
99
## Requirements
1010
- Unity Version 2021.3 or higher
@@ -19,7 +19,7 @@ The sample showcases a rudimentary PvP fighting game (e.g., Street Fighter, Tekk
1919
- Multiplayer Tools - v1.1.0
2020

2121
## Installation
22-
- Copy git URL by clicking on green CODE button and then by clicking on copy button as shown.
22+
- Copy git URL by clicking on green Code button and then by clicking on copy button as shown.
2323

2424
<img width="500" alt="image" src="https://github.com/readyplayerme/rpm-unity-sdk-netcode-support/assets/1121080/f2cfab7b-ac70-4120-ba13-4254647ad363">
2525

@@ -33,7 +33,7 @@ The sample showcases a rudimentary PvP fighting game (e.g., Street Fighter, Tekk
3333

3434
- After package installed you should see it under Ready Player Me block.
3535

36-
<img width="500" alt="image" src="https://github.com/readyplayerme/rpm-unity-sdk-netcode-support/assets/1121080/2adc2168-b59d-48cf-be57-983942cce2d8">
36+
<img width="500" alt="image" src="https://github.com/readyplayerme/rpm-unity-sdk-netcode-support/assets/1121080/7f9620cd-40aa-4d9a-92ab-090607782558">
3737

3838
- To get support for [Client Network Transform](https://docs-multiplayer.unity3d.com/netcode/current/components/networktransform/#owner-authoritative-mode) a package has to be installed manually.
3939
Copy the following url and past in `Add package from git URL` window in package manager.
@@ -42,7 +42,18 @@ The sample showcases a rudimentary PvP fighting game (e.g., Street Fighter, Tekk
4242
```
4343

4444
## Testing the Sample Project
45+
### Avatar Control
46+
- Select Ready Player Me Netcode Support in Package manager and import the Avatar Control sample.
47+
<img width="500" alt="image" src="https://github.com/readyplayerme/rpm-unity-sdk-netcode-support/assets/1121080/79dd9449-76d7-41df-ac43-bff53000281d">
48+
- Open the Avatar Control scene.<br>
49+
<img width="500" alt="image" src="https://github.com/readyplayerme/rpm-unity-sdk-netcode-support/assets/1121080/c4cebd6e-2e22-4316-bc0a-09fe1f106e57">
50+
- Add the scene to build settings.
51+
- Run the scene, paste your avatar URL and click on start button.
52+
- Build the scene and run it on another device to observe multiple avatars in the same scene.<br>
53+
<img width="500" alt="image" src="https://github.com/readyplayerme/rpm-unity-sdk-netcode-support/assets/1121080/5bcbf2a0-e113-403c-9327-18d8f5e14288">
54+
### Simple Figthing Game
4555
- Select Ready Player Me Netcode Support in Package manager and import the Basic Fighting Game sample.
56+
<img width="500" alt="image" src="https://github.com/readyplayerme/rpm-unity-sdk-netcode-support/assets/1121080/79401c2a-40e6-44d3-ac71-ceefda3252cd">
4657
- Open the menu scene.<br>
4758
<img width="500" alt="image" src="https://github.com/readyplayerme/rpm-unity-sdk-netcode-support/assets/1121080/c53ee18b-3e64-4534-82e1-ae05aabf1736">
4859
- Add menu and game scene to build settings.
@@ -61,17 +72,20 @@ The sample showcases a rudimentary PvP fighting game (e.g., Street Fighter, Tekk
6172

6273
#### [Network Variable](https://docs-multiplayer.unity3d.com/netcode/current/basics/networkvariable/)
6374
- Synchronizes a property ("variable") between a server and client(s).
64-
- Used for syncing player avatar url, name and animator parameters for movement.
75+
- Used for syncing player avatar url, name.
6576

6677
#### [Server RPC](https://docs-multiplayer.unity3d.com/netcode/current/advanced-topics/message-system/serverrpc/)
6778
- A remote procedure call (RPC) that can be only invoked by a client and will always be received and executed on the server/host.
6879
- Used for spawning fireball on server when a client player fires it.
6980

81+
#### [Network Animator](https://docs-multiplayer.unity3d.com/netcode/current/components/networkanimator/)
82+
- A component that synchronizes the state of an Animator between a server and client(s).
83+
7084
## TODO
7185

72-
- Use [Network Animator](https://docs-multiplayer.unity3d.com/netcode/current/learn/dilmer/networkanimator/) instead of syncing animator parameters using network variable.
7386
- Fix player rotation sync.
7487
- Animation for fireball.
7588

7689
## Known Issues
90+
- **Avatar Partially Loading:** If you did not use a Texture Atlas size selected in yout Avatar Config, you will receive avatar in multiple meshes and you might observe only eyes of the avatar being loaded and that you are getting an `IndexOutOfRangeException: Index was outside the bounds of the array.` error message. Multiple mesh avatars are not yet supported in the package so please use a config with atlas size selected.
7791
- **Shared Access Violation Error:** When you test your build locally, all the game instances will try to write avatar file at the same time due to first time download and cause a file read error. Even though remote players won't experience this issue it is troubling while testing your app. You might test with same avatars and after they are cached this issue should not occur.

0 commit comments

Comments
 (0)