Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fleet docs: Some missing pieces. #204

Merged
merged 1 commit into from
May 15, 2018
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
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