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

Commit 4bf3371

Browse files
author
Jamie Brynes
authoredMay 4, 2020
Update readme (#270)
1 parent 66678a2 commit 4bf3371

File tree

2 files changed

+38
-4
lines changed

2 files changed

+38
-4
lines changed
 
799 KB
Loading

‎README.md

+38-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,43 @@
1-
# The SpatialOS GDK for Unity FPS Starter Project readme (alpha)
1+
<div align="center">
2+
<img src="./.github/fps-starter-project-thumbnail.png" width="450" />
23

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

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

7-
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).
10+
<p>
11+
<img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg"/>
12+
<img alt="Build status" src="https://badge.buildkite.com/61c73ff2bf4f7404ab89b6f768afd3fbce1b6a44476806ba6b.svg?branch=develop"/>
13+
<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>
14+
</p>
15+
16+
<h4>
17+
<a href="https://documentation.improbable.io/gdk-for-unity/docs/fps-get-started-tutorial">Get started</a>
18+
<span> | </span>
19+
<a href="https://documentation.improbable.io/gdk-for-unity/docs/fps-health-packs-tutorial">Health packs tutorial</a>
20+
<span> | </span>
21+
<a href="https://github.com/spatialos/gdk-for-unity-fps-starter-project/blob/master/CHANGELOG.md">Changelog</a>
22+
</h4>
23+
</div>
24+
25+
## About
26+
27+
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:
28+
29+
* Basic player spawning, movement, and shooting systems.
30+
* An implementation of simulated players for load-testing.
31+
* Variable-sized map generation.
32+
33+
> 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.
34+
35+
## Contributions
36+
37+
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.
38+
39+
---
40+
41+
* 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.
842

943
&copy; 2020 Improbable

0 commit comments

Comments
 (0)