-
Notifications
You must be signed in to change notification settings - Fork 136
Feat: Readme Updates [MTT-5460] #96
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
6973898
Readme updates
jilfranco-unity 8b086c4
more github readme updates
jilfranco-unity a5ca036
in editor readme for dynamic prefabs--will update temporary image
jilfranco-unity 4b439e8
readme updates, comments addressed
jilfranco-unity 328fa4d
little readme updates with what to do in each scene for the other bit…
jilfranco-unity 4e870d0
Update Basic/DynamicAddressablesNetworkPrefabs/README.md
jilfranco-unity 9f5294d
Update Basic/DynamicAddressablesNetworkPrefabs/README.md
jilfranco-unity 43fad9a
Update Basic/2DSpaceShooter/README.md
SamuelBellomo 291b4b2
readme updates
jilfranco-unity dfe22a1
Merge branch 'feat/readme-updates-postrename' of https://github.com/U…
jilfranco-unity 00c5269
version update to 1.2.0 and some tiny in project readme edits to brin…
jilfranco-unity 7cd2ab7
updated readme image to match current UI
jilfranco-unity 3872aa9
okay updated again to this cuter version
jilfranco-unity 96438a3
Merge branch 'develop' into feat/readme-updates-postrename
jilfranco-unity File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,41 @@ | ||
## 2D Space Shooter | ||
# 2D Space Shooter | ||
|
||
This is a UNet sample project converted to Netcode for GameObjects. | ||
 | ||
 | ||
[](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/releases/tag/v1.2.0) | ||
<br><br> | ||
|
||
## Sample Features | ||
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. | ||
<br><br> | ||
|
||
This sample shows you: | ||
# Sample Overview | ||
|
||
- Server authorative physics based movement | ||
- Managing health and a list of buffs for your players in a multiplayer game | ||
In this sample, learn more about: | ||
|
||
- Server authorative physics based movement using Netcode for GameObject's `NetworkRigidbody2D` component | ||
- Managing health and a list of buffs for your players in a multiplayer game with a `NetworkVariable` | ||
- How to pool network objects such as bullets and asteroids to improve performance | ||
jilfranco-unity marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<br><br> | ||
--- | ||
### 💡 Documentation | ||
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. | ||
|
||
--- | ||
<br> | ||
|
||
## Exploring the Sample | ||
|
||
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). | ||
<br><br> | ||
|
||
|
||
--- | ||
### 💡 Bitesize Readme | ||
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. | ||
|
||
--- | ||
<br> | ||
|
||
## Future Work | ||
- Add a way to assign a player name to each player. | ||
[](https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-introduction) | ||
jilfranco-unity marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[](https://forum.unity.com/forums/multiplayer.26/) | ||
[](https://discord.gg/FM8SE9E) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,40 @@ | ||
# Client Driven | ||
|
||
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 | ||
 | ||
 | ||
[](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/releases/tag/v1.2.0) | ||
<br><br> | ||
|
||
## Sample feature | ||
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. | ||
<br><br> | ||
|
||
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. | ||
It also provides a client side object detection with server side pickup, showing client driven patterns and networked object reparenting. | ||
These physics objects are spawned server side at regular intervals and can be pushed around by client driven players. | ||
# Sample Overview | ||
jilfranco-unity marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
In this sample, learn more about: | ||
|
||
- Client driven movements | ||
- Networked physics | ||
- Spawning vs in-scene placed `NetworkObjects` | ||
- `NetworkObject` parenting (client side object detection with server side pickup) | ||
<br><br> | ||
--- | ||
### 💡 Documentation | ||
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. | ||
|
||
--- | ||
<br> | ||
|
||
## Exploring the Sample | ||
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. | ||
<br><br> | ||
|
||
--- | ||
### 💡 Bitesize Readme | ||
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. | ||
|
||
--- | ||
<br> | ||
|
||
[](https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-introduction) | ||
[](https://forum.unity.com/forums/multiplayer.26/) | ||
[](https://discord.gg/FM8SE9E) |
83 changes: 83 additions & 0 deletions
83
Basic/DynamicAddressablesNetworkPrefabs/Assets/Readme.asset
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
%YAML 1.1 | ||
%TAG !u! tag:unity3d.com,2011: | ||
--- !u!114 &11400000 | ||
MonoBehaviour: | ||
m_ObjectHideFlags: 0 | ||
m_CorrespondingSourceObject: {fileID: 0} | ||
m_PrefabInstance: {fileID: 0} | ||
m_PrefabAsset: {fileID: 0} | ||
m_GameObject: {fileID: 0} | ||
m_Enabled: 1 | ||
m_EditorHideFlags: 0 | ||
m_Script: {fileID: 11500000, guid: 5ce0e387261ddc34ba81ca7f2f1f7f73, type: 3} | ||
m_Name: Readme | ||
m_EditorClassIdentifier: | ||
icon: {fileID: 2800000, guid: 06a678a9706d69242bc9e034adc27168, type: 3} | ||
title: 'Dynamic Prefabs: A Bitesize Sample' | ||
sections: | ||
- heading: | ||
text: | ||
linkText: | ||
url: | ||
- heading: 'Exploring the Sample:' | ||
text: | ||
linkText: | ||
url: | ||
- heading: | ||
text: 'The Dynamic Prefabs sample showcases the available use-cases for the dynamic | ||
prefab system, which allows us to add new spawnable prefabs at runtime. ' | ||
linkText: | ||
url: | ||
- heading: | ||
text: Each scene in the project showcases a different, isolated feature of the | ||
API, allowing for easy extraction into other projects. We suggest exploring | ||
them in sequential order to get an understanding of the flow of dynamically | ||
loading and spawning network prefabs. | ||
linkText: | ||
url: | ||
- heading: | ||
text: Scenes 00-04 showcase example use-cases for the Dynamic Prefabs system, | ||
and scene 05 serves as an API playground to test how all of the use-cases in | ||
can work tandem. Please see our code comments for implemetation details on | ||
each use-case. | ||
linkText: | ||
url: | ||
- heading: ' ' | ||
text: | ||
linkText: | ||
url: | ||
- heading: | ||
text: This sample also uses in-game UI (created using UI Toolkit) to interface | ||
with the dynamic prefabs system with configurable options like artificial latency | ||
and network spawn timeout for easy testing. | ||
linkText: | ||
url: | ||
- heading: ' ' | ||
text: | ||
linkText: | ||
url: | ||
- heading: 'To Learn More:' | ||
text: | ||
linkText: | ||
url: | ||
- heading: | ||
text: For more information about this bitesize sample, check out the | ||
linkText: Dynamic Prefabs bitesize sample documentation, | ||
url: https://docs-multiplayer.unity3d.com/netcode/current/learn/bitesize/bitesize-dynamicprefabs/index.html | ||
- heading: | ||
text: 'as well as the GitHub repo Readme from the ' | ||
linkText: Bitesize Samples public GitHub repository. | ||
url: https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize | ||
- heading: | ||
text: Read more about Netcode and its built-in features from the | ||
linkText: Netcode documentation. | ||
url: https://docs-multiplayer.unity3d.com/ | ||
- heading: ' ' | ||
text: | ||
linkText: | ||
url: | ||
- heading: | ||
text: Also, check out our | ||
linkText: Multiplayer Discord! | ||
url: https://discord.gg/FM8SE9E | ||
loadedLayout: 1 |
8 changes: 8 additions & 0 deletions
8
Basic/DynamicAddressablesNetworkPrefabs/Assets/Readme.asset.meta
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
8 changes: 8 additions & 0 deletions
8
Basic/DynamicAddressablesNetworkPrefabs/Assets/Scripts/Readme.meta
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
8 changes: 8 additions & 0 deletions
8
Basic/DynamicAddressablesNetworkPrefabs/Assets/Scripts/Readme/Editor.meta
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.