Skip to content

Commit fe1ed71

Browse files
Feat: Readme Updates [MTT-5460] (#96)
* Readme updates * more github readme updates * in editor readme for dynamic prefabs--will update temporary image * readme updates, comments addressed * little readme updates with what to do in each scene for the other bitesize samples * Update Basic/DynamicAddressablesNetworkPrefabs/README.md Co-authored-by: Sam Bellomo <[email protected]> * Update Basic/DynamicAddressablesNetworkPrefabs/README.md Co-authored-by: Sam Bellomo <[email protected]> * Update Basic/2DSpaceShooter/README.md * readme updates * version update to 1.2.0 and some tiny in project readme edits to bring them on par with the gihub ones * updated readme image to match current UI * okay updated again to this cuter version --------- Co-authored-by: Sam Bellomo <[email protected]>
1 parent 391df99 commit fe1ed71

File tree

23 files changed

+788
-60
lines changed

23 files changed

+788
-60
lines changed

Basic/2DSpaceShooter/Assets/Readme.asset

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ MonoBehaviour:
2424
url: https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-spaceshooter/index.html
2525
- heading:
2626
text: The entry scene for this game is the network scene. From there a game can
27-
be hosted or an existing game can be joined.
27+
be hosted or an existing game can be joined. Control the ship using WASD and
28+
shoot asteroids (or other players!) using the spacebar. Fly over pickups in
29+
the scene to get different temporary buffs for your ship (like increased fly
30+
speed or shooting extra bullets).
2831
linkText:
2932
url:
3033
- heading:

Basic/2DSpaceShooter/ProjectSettings/ProjectSettings.asset

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ PlayerSettings:
134134
16:10: 1
135135
16:9: 1
136136
Others: 1
137-
bundleVersion: 1.1.0
137+
bundleVersion: 1.2.0
138138
preloadedAssets: []
139139
metroInputSource: 1
140140
wsaTransparentSwapchain: 0

Basic/2DSpaceShooter/README.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
1-
## 2D Space Shooter
1+
# 2D Space Shooter
22

3-
This is a UNet sample project converted to Netcode for GameObjects.
3+
![UnityVersion](https://img.shields.io/badge/Unity%20Version:-2021.3%20LTS-57b9d3.svg?logo=unity&color=2196F3)
4+
![NetcodeVersion](https://img.shields.io/badge/Netcode%20Version:-1.2.0-57b9d3.svg?logo=unity&color=2196F3)
5+
[![LatestRelease](https://img.shields.io/badge/Latest%20%20Github%20Release:-v1.2.0-57b9d3.svg?logo=github&color=brightgreen)](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/releases/tag/v1.2.0)
6+
<br><br>
47

5-
## Sample Features
8+
This is a UNet sample project converted to Netcode for GameObjects. The 2DSpaceShooter sample is a bitesize sample designed to demonstrate networked 2D and physics-based character movement.
9+
<br><br>
610

7-
This sample shows you:
11+
# Sample Overview
812

9-
- Server authorative physics based movement
10-
- Managing health and a list of buffs for your players in a multiplayer game
13+
In this sample, learn more about:
14+
15+
- Server authorative physics based movement using Netcode for GameObject's `NetworkRigidbody2D` component
16+
- Managing health and a list of buffs for your players in a multiplayer game with a `NetworkVariable`
1117
- How to pool network objects such as bullets and asteroids to improve performance
18+
<br><br>
19+
---
20+
### 💡 Documentation
21+
Check out our [Bitesize Samples documentation](https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-introduction) for a more in-depth technical breakdown of our engineering decisions and why the sample works the way it does.
22+
23+
---
24+
<br>
25+
26+
## Exploring the Sample
27+
28+
The entry scene for this game is the network scene. From there a game can be hosted or an existing game can be joined. Control the ship using WASD and shoot asteroids (or other players!) using the spacebar. Fly over pickups in the scene to get different temporary buffs for your ship (like increased fly speed or shooting extra bullets).
29+
<br><br>
30+
31+
32+
---
33+
### 💡 Bitesize Readme
34+
Check out our main [Bitesize Samples GitHub Readme](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize#readme) for more documentation, resources, releases, contribution guidelines, and our feedback form.
35+
36+
---
37+
<br>
1238

13-
## Future Work
14-
- Add a way to assign a player name to each player.
39+
[![Documentation](https://img.shields.io/badge/Unity-bitesize--docs-57b9d3.svg?logo=unity&color=2196F3)](https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-introduction)
40+
[![Forums](https://img.shields.io/badge/Unity-multiplayer--forum-57b9d3.svg?logo=unity&color=2196F3)](https://forum.unity.com/forums/multiplayer.26/)
41+
[![Discord](https://img.shields.io/discord/449263083769036810.svg?label=discord&logo=discord&color=5865F2)](https://discord.gg/FM8SE9E)

Basic/ClientDriven/Assets/Readme.asset

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,10 @@ MonoBehaviour:
2626
url: https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-clientdriven/index.html
2727
- heading:
2828
text: The entry scene for this game is the Bootstrap scene. From there a game
29-
can be hosted or an existing game can be joined.
29+
can be hosted or an existing game can be joined. Run around the scene using
30+
WASD, and pick up orbs using the spacebar. Convert orbs from one color to another
31+
by dropping them in the converters in the middle of the level. Deposit orbs
32+
into the drop spots of the same color to earn points.
3033
linkText:
3134
url:
3235
- heading:

Basic/ClientDriven/ProjectSettings/ProjectSettings.asset

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ PlayerSettings:
134134
16:10: 1
135135
16:9: 1
136136
Others: 1
137-
bundleVersion: 1.1.0
137+
bundleVersion: 1.2.0
138138
preloadedAssets:
139139
- {fileID: 11400000, guid: 9e7be553448fa2546aea5752021cbcf7, type: 2}
140140
metroInputSource: 0

Basic/ClientDriven/README.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,40 @@
11
# Client Driven
22

3-
This is a sample project oriented to Client Driven behaviour using Netcode for GameObjects. In this sample you will learn more about Client driven movements, networked physics, spawning vs statically placed objects, object reparenting
3+
![UnityVersion](https://img.shields.io/badge/Unity%20Version:-2021.3%20LTS-57b9d3.svg?logo=unity&color=2196F3)
4+
![NetcodeVersion](https://img.shields.io/badge/Netcode%20Version:-1.2.0-57b9d3.svg?logo=unity&color=2196F3)
5+
[![LatestRelease](https://img.shields.io/badge/Latest%20%20Github%20Release:-v1.2.0-57b9d3.svg?logo=github&color=brightgreen)](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/releases/tag/v1.2.0)
6+
<br><br>
47

5-
## Sample feature
8+
The ClientDriven sample is a sample project made with Netcode for GameObjects designed to demonstrate responsive 3rd-person WASD character movements even under unfavourable network conditions.
9+
<br><br>
610

7-
Making movements feel responsive while staying consistent over multiple game executables is a challenge for many networked games. ClientDriven's aim is to create a quick sample to show responsive character movements that don't feel sluggish, even under bad network conditions.
8-
It also provides a client side object detection with server side pickup, showing client driven patterns and networked object reparenting.
9-
These physics objects are spawned server side at regular intervals and can be pushed around by client driven players.
11+
# Sample Overview
12+
13+
In this sample, learn more about:
14+
15+
- Client driven movements
16+
- Networked physics
17+
- Spawning vs in-scene placed `NetworkObjects`
18+
- `NetworkObject` parenting (client side object detection with server side pickup)
19+
<br><br>
20+
---
21+
### 💡 Documentation
22+
Check out our [Bitesize Samples documentation](https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-introduction) for a more in-depth technical breakdown of our engineering decisions and why the sample works the way it does.
23+
24+
---
25+
<br>
26+
27+
## Exploring the Sample
28+
The entry scene for this game is the Bootstrap scene. From there a game can be hosted or an existing game can be joined. Run around the scene using WASD, and pick up orbs using the spacebar. Convert orbs from one color to another by dropping them in the converters in the middle of the level. Deposit orbs into the drop spots of the same color to earn points.
29+
<br><br>
30+
31+
---
32+
### 💡 Bitesize Readme
33+
Check out our main [Bitesize Samples GitHub Readme](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize#readme) for more documentation, resources, releases, contribution guidelines, and our feedback form.
34+
35+
---
36+
<br>
37+
38+
[![Documentation](https://img.shields.io/badge/Unity-bitesize--docs-57b9d3.svg?logo=unity&color=2196F3)](https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-introduction)
39+
[![Forums](https://img.shields.io/badge/Unity-multiplayer--forum-57b9d3.svg?logo=unity&color=2196F3)](https://forum.unity.com/forums/multiplayer.26/)
40+
[![Discord](https://img.shields.io/discord/449263083769036810.svg?label=discord&logo=discord&color=5865F2)](https://discord.gg/FM8SE9E)
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
%YAML 1.1
2+
%TAG !u! tag:unity3d.com,2011:
3+
--- !u!114 &11400000
4+
MonoBehaviour:
5+
m_ObjectHideFlags: 0
6+
m_CorrespondingSourceObject: {fileID: 0}
7+
m_PrefabInstance: {fileID: 0}
8+
m_PrefabAsset: {fileID: 0}
9+
m_GameObject: {fileID: 0}
10+
m_Enabled: 1
11+
m_EditorHideFlags: 0
12+
m_Script: {fileID: 11500000, guid: 5ce0e387261ddc34ba81ca7f2f1f7f73, type: 3}
13+
m_Name: Readme
14+
m_EditorClassIdentifier:
15+
icon: {fileID: 2800000, guid: 06a678a9706d69242bc9e034adc27168, type: 3}
16+
title: 'Dynamic Prefabs: A Bitesize Sample'
17+
sections:
18+
- heading:
19+
text:
20+
linkText:
21+
url:
22+
- heading: 'Exploring the Sample:'
23+
text:
24+
linkText:
25+
url:
26+
- heading:
27+
text: 'The Dynamic Prefabs sample showcases the available use-cases for the dynamic
28+
prefab system, which allows us to add new spawnable prefabs at runtime. '
29+
linkText:
30+
url:
31+
- heading:
32+
text: Each scene in the project showcases a different, isolated feature of the
33+
API, allowing for easy extraction into other projects. We suggest exploring
34+
them in sequential order to get an understanding of the flow of dynamically
35+
loading and spawning network prefabs.
36+
linkText:
37+
url:
38+
- heading:
39+
text: Scenes 00-04 showcase example use-cases for the Dynamic Prefabs system,
40+
and scene 05 serves as an API playground to test how all of the use-cases in
41+
can work tandem. Please see our code comments for implemetation details on
42+
each use-case.
43+
linkText:
44+
url:
45+
- heading: ' '
46+
text:
47+
linkText:
48+
url:
49+
- heading:
50+
text: This sample also uses in-game UI (created using UI Toolkit) to interface
51+
with the dynamic prefabs system with configurable options like artificial latency
52+
and network spawn timeout for easy testing.
53+
linkText:
54+
url:
55+
- heading: ' '
56+
text:
57+
linkText:
58+
url:
59+
- heading: 'To Learn More:'
60+
text:
61+
linkText:
62+
url:
63+
- heading:
64+
text: For more information about this bitesize sample, check out the
65+
linkText: Dynamic Prefabs bitesize sample documentation,
66+
url: https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-dynamicprefabs/index.html
67+
- heading:
68+
text: 'as well as the GitHub repo Readme from the '
69+
linkText: Bitesize Samples public GitHub repository.
70+
url: https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize
71+
- heading:
72+
text: Read more about Netcode and its built-in features from the
73+
linkText: Netcode documentation.
74+
url: https://docs-multiplayer.unity3d.com/
75+
- heading: ' '
76+
text:
77+
linkText:
78+
url:
79+
- heading:
80+
text: Also, check out our
81+
linkText: Multiplayer Discord!
82+
url: https://discord.gg/FM8SE9E
83+
loadedLayout: 1

Basic/DynamicAddressablesNetworkPrefabs/Assets/Readme.asset.meta

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Basic/DynamicAddressablesNetworkPrefabs/Assets/Scripts/Readme.meta

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Basic/DynamicAddressablesNetworkPrefabs/Assets/Scripts/Readme/Editor.meta

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)