Skip to content

Commit

Permalink
Fleet docs: Some missing pieces.
Browse files Browse the repository at this point in the history
Noticed some missing connective parts
in the fleet documentation. Adding those now.
  • Loading branch information
markmandel authored and cyriltovena committed May 15, 2018
1 parent 874081d commit a8f5327
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,12 @@ Documentation and usage guides on how to develop and host dedicated game servers

### Reference
- [Game Server Specification](./docs/gameserver_spec.md)
- [Fleet Specification](./docs/fleet_spec.md)

### Examples
- [Full GameServer Configuration](./examples/gameserver.yaml)
- [Full Fleet Configuration](./examples/fleet.yaml)
- [Full Fleet Allocation Configuration](./examples/fleetallocation.yaml)
- [Simple UDP](./examples/simple-udp) (Go) - simple server and client that send UDP packets back and forth.
- [CPP Simple](./examples/cpp-simple) (C++) - C++ example that starts up, stays healthy and then shuts down after 60 seconds.
- [Xonotic](./examples/xonotic) - Wraps the SDK around the open source FPS game [Xonotic](http://www.xonotic.org) and hosts it on Agones.
Expand Down
2 changes: 2 additions & 0 deletions docs/fleet_spec.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
⚠️⚠️⚠️ **This is currently a development feature and has not been released** ⚠️⚠️⚠️

# Fleet Specification

A `Fleet` is a set of warm GameServers that are available to be allocated from.
Expand Down

0 comments on commit a8f5327

Please sign in to comment.