Skip to content
This repository has been archived by the owner on Oct 20, 2021. It is now read-only.

Commit

Permalink
Update readme (#270)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jamie Brynes authored May 4, 2020
1 parent 66678a2 commit 4bf3371
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 4 deletions.
Binary file added .github/fps-starter-project-thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 38 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,43 @@
# The SpatialOS GDK for Unity FPS Starter Project readme (alpha)
<div align="center">
<img src="./.github/fps-starter-project-thumbnail.png" width="450" />

This starter project is designed to help you get started quickly with the [SpatialOS GDK for Unity](https://github.com/spatialos/gdk-for-unity).
<h1>The GDK for Unity FPS Starter Project</h1>

## Getting started
<p>
<strong>An example implementation of an FPS game on the <a href="https://github.com/spatialos/gdk-for-unity">GDK for Unity</a></strong>
</p>

For information on installing, running and playing the FPS Starter Project, please see our [getting started guide](https://documentation.improbable.io/gdk-for-unity/docs/fps-get-started-tutorial).
<p>
<img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg"/>
<img alt="Build status" src="https://badge.buildkite.com/61c73ff2bf4f7404ab89b6f768afd3fbce1b6a44476806ba6b.svg?branch=develop"/>
<a href="https://github.com/spatialos/gdk-for-unity-fps-starter-project/releases"><img alt="Current release" src="https://img.shields.io/github/release/spatialos/gdk-for-unity-fps-starter-project.svg"/></a>
</p>

<h4>
<a href="https://documentation.improbable.io/gdk-for-unity/docs/fps-get-started-tutorial">Get started</a>
<span> | </span>
<a href="https://documentation.improbable.io/gdk-for-unity/docs/fps-health-packs-tutorial">Health packs tutorial</a>
<span> | </span>
<a href="https://github.com/spatialos/gdk-for-unity-fps-starter-project/blob/master/CHANGELOG.md">Changelog</a>
</h4>
</div>

## About

The GDK for Unity First-Person Shooter (FPS) Starter Project is an example implementation of an FPS-genre game on top of the [SpatialOS GDK for Unity](https://github.com/spatialos/gdk-for-unity). It features:

* Basic player spawning, movement, and shooting systems.
* An implementation of simulated players for load-testing.
* Variable-sized map generation.

> Note: The FPS Starter Project is _not_ production ready. For example, the shooting and movement systems are client-side authoritative. If you shipped a game based on the FPS Starter Project without hardening these systems, these systems would be vulnerabilities that a bad actor could exploit.
## Contributions

We are not currently accepting public contributions - see our [contributions](https://documentation.improbable.io/gdk-for-unity/docs/contribution-policy-on-github) policy. However, we are accepting issues and will gratefully appreciate your feedback.

---

* Your access to and use of the Unity Engine is governed by the Unity Engine End User License Agreement. Please ensure that you have agreed to those terms before you access or use the Unity Engine.

&copy; 2020 Improbable

0 comments on commit 4bf3371

Please sign in to comment.