-
Notifications
You must be signed in to change notification settings - Fork 136
docs: README updates and CHANGELOG #1
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
5 commits
Select commit
Hold shift + click to select a range
2c9c166
readme updates and changelog
lkrell b735211
Apply suggestions from code review
lkrell 27e986a
revising project name across all files
lkrell c3690f8
filename fix
lkrell 091e80a
Update .github/ISSUE_TEMPLATE/bug_report.md
Cosmin-B 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,9 +1,11 @@ | ||
| # Invaders | ||
| This is a UNet sample project converted to MLAPI. | ||
|
|
||
| # This sample shows you | ||
| - Simple start/lobby/finish flow with MLAPI using Scene Management | ||
| This is a UNet sample project converted to Unity MLAPI. | ||
|
|
||
| - Unconventional movement networked | ||
| ## Sample Features | ||
|
|
||
| This sample shows you: | ||
|
|
||
| - Shared timer between clients - in a client-sided predicted way | ||
| - Simple start, lobby, and finish flow with Unity MLAPI using Scene Management | ||
| - Unconventional movement networked | ||
| - Shared timer between clients in a client-sided predicted way |
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,14 @@ | ||
| # Change log | ||
|
|
||
| ## [0.1.0] - 2021-04-07 | ||
|
|
||
| Initial release of MLAPI Bitesize Samples repository. Samples support the following versions: | ||
|
|
||
| | Unity Version | Unity MLAPI Version | | ||
| | -- | -- | | ||
| | 2020.3 | 0.1.0 | | ||
|
|
||
| ### New features | ||
|
|
||
| - Added Invaders sample. | ||
| - Added 2D Space Shooter sample. |
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 +1 @@ | ||
| The MLAPI Shared Samples Repository follows the same code of conduct as the MLAPI repository. Please read the [MLAPI code of conduct](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/blob/master/CODE_OF_CONDUCT.md), thank you! | ||
| The MLAPI Bitesize Samples Repository follows the same code of conduct as the MLAPI repository. Please read the [MLAPI code of conduct](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/blob/master/CODE_OF_CONDUCT.md), thank you! |
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,24 +1,28 @@ | ||
| # MLAPI Shared Samples | ||
| # MLAPI Bitesize Samples | ||
|
|
||
| |Unity Version|MLAPI Version| | ||
| |Unity Version|Unity MLAPI Version| | ||
| |:-------:|:-------:| | ||
| |2020.3|0.1.0| | ||
|
|
||
| This repository contains a collection of mini sample projects/games that showcase different | ||
| sub-features of [MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi) | ||
| as well as being used for [Documentation](https://docs-multiplayer-sandbox.unity3d.com/docs/getting-started/about-mlapi) purposes. | ||
| This repository contains a collection of bitesize sample projects and games that showcase different | ||
| sub-features of [MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi). You can review these samples with [documentation](https://docs-multiplayer-sandbox.unity3d.com/docs/getting-started/about-mlapi) to better understand APIs and features. | ||
|
|
||
| ## Who is this for? | ||
|
|
||
| The samples in this repository exist to help you getting started with development of a multiplayer | ||
| project using [MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi) | ||
| if you just got past the "Hello World" stage and are interested in how you can use some specific sub-features of [MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi) in a more self-contained scenario. | ||
| The samples in this repository help you get started with development of a multiplayer | ||
| project using [Unity MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi). | ||
|
|
||
| ## Requirements | ||
|
|
||
| You need Unity and [Unity MLAPI](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases/latest) installed to use these samples. Complete the [Hello World Getting Started](https://docs-multiplayer.unity3d.com/docs/tutorials/helloworldintro/index.html) to prepare your environment. You can then access and use these samples to MLAPI in a more self-contained scenario. | ||
|
|
||
| ## Community and Feedback | ||
|
|
||
| For help, questions, networking advice or discussions about MLAPI and its extensions, please join our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/). | ||
|
|
||
| ## Maintenance | ||
| The Shared Samples Repository will be kept up to date with the latest released MLAPI version and LTS version of Unity. We indicate the currently used versions of Unity and MLAPI at the top of the readme. | ||
|
|
||
| The MLAPI Bitesize Samples repository will be maintained and updated with the latest released MLAPI version and Unity LTS version. See this readme and the changelog for supported versions. | ||
|
|
||
| ## Contributing | ||
| Check out or [contribution guidelines](CONTRIBUTING.md) | ||
| These samples, projects, and Unity MLAPI are open-source and welcome contributions. See our [contribution guidelines](CONTRIBUTING.md) for details. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Legal may need to rethink this license. It outlaws forking and copying of the source code, prohibits contribution, etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In discussion with Legal
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you have a decision, we can add that to this PR if you like. Or review to complete this PR. Thanks!