diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 18b3e51c9..4d76285fd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -27,7 +27,7 @@ If applicable, add screenshots to help explain your problem. - OS: [e.g. Windows 10] - Unity Version: [e.g. 2019.1] - MLAPI Version: [e.g. v6.0.1] - - Shared Samples Repository Version/Commit + - Bitesize Samples Repository Version/Commit **Additional context** Add any other context about the problem here. diff --git a/Basic/2DSpaceShooter/README.md b/Basic/2DSpaceShooter/README.md index b3a3859d5..8b6f8edd4 100644 --- a/Basic/2DSpaceShooter/README.md +++ b/Basic/2DSpaceShooter/README.md @@ -1,16 +1,16 @@ ## 2D Space Shooter -This is a UNet sample project converted to MLAPI. +This is a UNet sample project converted to Unity MLAPI. -## This sample shows you +## Sample Features -- Server authorative physics based movement. +This sample shows you: -- Managing health and a list of buffs for your players in a multiplayer game. +- Server authorative physics based movement +- Managing health and a list of buffs for your players in a multiplayer game +- How to pool network objects such as bullets and asteroids to improve performance -- How to pool network objects such as bullets and asteroids to improve performance. - -## TODO +## Future Work - Player should spawn at random position instead of center of the map. - Add a way to assign a player name to each player. diff --git a/Basic/Invaders/README.md b/Basic/Invaders/README.md index 3ee1255e0..18722d84d 100644 --- a/Basic/Invaders/README.md +++ b/Basic/Invaders/README.md @@ -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 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..4c43d0316 --- /dev/null +++ b/CHANGELOG.md @@ -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. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 7aefba0d1..cf7986638 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -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! \ No newline at end of file +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! \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f00d479a..6a775f0d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,35 +1,33 @@ # Contributing -Thank you for your interest in contributing to MLAPI Shared Samples Repository! +Thank you for your interest in contributing to MLAPI Bitesize Samples repository! Here are our guidelines for contributing: -* [Code of Conduct](#coc) -* [Ways to Contribute](#ways) -* [Issues and Bugs](#issue) -* [Feature Requests](#feature) -* [Improving Documentation](#docs) -* [Unity Contribution Agreement](#cla) -* [Pull Request Submission Guidelines](#submit-pr) +* [Contributing](#contributing) + * [ Code of Conduct](#-code-of-conduct) + * [ Ways to Contribute](#-ways-to-contribute) + * [ Issues and Bugs](#-issues-and-bugs) + * [ Feature Requests](#-feature-requests) + * [ Contributor License Agreements](#-contributor-license-agreements) ## Code of Conduct -Please help us keep BossRoom open and inclusive. Read and follow our [Code of Conduct](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/blob/master/CODE_OF_CONDUCT.md). +Please help us keep MLAPI Bitesize Samples open and inclusive. Read and follow our [Code of Conduct](https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/blob/master/CODE_OF_CONDUCT.md). ## Ways to Contribute -There are many ways in which you can contribute to the BossRoom. +There are many ways in which you can contribute to MLAPI Bitesize Samples. ### Issues and Bugs -If you find a bug in the source code, you can help us by submitting an issue to our -GitHub Repository. Even better, you can submit a Pull Request with a fix. +If you find a bug in the source code, you can help us by submitting an [issue](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/issues/new/choose) to our GitHub Repository. Even better, you can submit a Pull Request with a fix. ### Feature Requests Please note that the goal of this repository is to provide educational content to learn MLAPI. -If you would like to see a certain feature in the samples or implement one yourself, create a request by [submitting an issue](TODO Link) to our GitHub Repository. +If you would like to see a certain feature in the samples or implement one yourself, create a request by [submitting an issue]([TODO Link](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/issues/new?assignees=&labels=stat%3Aawaiting+triage%2C+type%3Afeature&template=feature_request.md&title=)) to our GitHub Repository. If you would like to implement a new feature then please also get in contact with us in the #dev-samples channel of our [Discord](https://discord.gg/buMxnnPvTb). diff --git a/LICENSE.md b/LICENSE.md index a2a035fed..d7530a364 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Multiplayer Shared Samples Repository © 2021 Unity Technologies +Multiplayer Bitesize Samples Repository © 2021 Unity Technologies Licensed under the Unity Companion License for Unity-dependent projects (see https://unity3d.com/legal/licenses/unity_companion_license); otherwise licensed under the Unity Package Distribution License (see https://unity3d.com/legal/licenses/Unity_Package_Distribution_License). diff --git a/README.md b/README.md index f51014f31..72efb657e 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file +These samples, projects, and Unity MLAPI are open-source and welcome contributions. See our [contribution guidelines](CONTRIBUTING.md) for details.