Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
14 changes: 7 additions & 7 deletions Basic/2DSpaceShooter/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
12 changes: 7 additions & 5 deletions Basic/Invaders/README.md
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
14 changes: 14 additions & 0 deletions CHANGELOG.md
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.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
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!
24 changes: 11 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)
* [<a name="coc"></a> Code of Conduct](#-code-of-conduct)
* [<a name="ways"></a> Ways to Contribute](#-ways-to-contribute)
* [<a name="issue"></a> Issues and Bugs](#-issues-and-bugs)
* [<a name="feature"></a> Feature Requests](#-feature-requests)
* [<a name="cla"></a> Contributor License Agreements](#-contributor-license-agreements)

## <a name="coc"></a> 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).

## <a name="ways"></a> 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.

### <a name="issue"></a> 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.

### <a name="feature"></a> 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).

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -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).
Copy link
Contributor Author

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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In discussion with Legal

Copy link
Contributor Author

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!


Expand Down
24 changes: 14 additions & 10 deletions README.md
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.