# servers.ron

> The server browser's list.

<!-- Generated by `zombye-server --docs`. Do not edit: change the game and generate again. -->

**The server browser's list.** Read by the game client only: a change here changes how it looks or sounds, never how it plays.

File: `assets/data/servers.ron`

## About this file

The server browser's list (#27; F7 in the game): the servers it shows when no other list is set. Shipped empty: nobody runs a public list for the game yet, and the game asks no service of ours.

Use another list with `--server-list FILE|http://HOST/PATH`, or `server_list: Some("...")` in the client's settings.ron (in the saves folder). Anyone can keep one: it is this format, as a file or behind a plain http:// address (https can't be read yet).

```text
  address   host or host:port (port 7777 without). Required.
  name      shown until the server answers with its own name.
  featured  true puts it in the Featured section at the top.
  note      one line from the list's keeper: region, who hosts it, when it restarts.
```

(

```text
    servers: [
        (address: "play.example.org", name: "Example co-op", featured: true, note: "EU, hosted by Example"),
        (address: "203.0.113.7:7778"),
    ],
```

)


## Fields

The file is one `ServerList`.

| Field | Type | What it is |
|---|---|---|
| `servers` | `Vec<ListEntry>` |  |

### `ListEntry`

One server in a list.

| Field | Type | What it is |
|---|---|---|
| `address` | `String` |  |
| `name` | `String` |  |
| `featured` | `bool` |  |
| `note` | `String` |  |

## The file

<details>
<summary>The whole file as shipped</summary>

```ron
// The server browser's list (#27; F7 in the game): the servers it shows when no other list is set.
// Shipped empty: nobody runs a public list for the game yet, and the game asks no service of ours.
//
// Use another list with `--server-list FILE|http://HOST/PATH`, or `server_list: Some("...")` in
// the client's settings.ron (in the saves folder). Anyone can keep one: it is this format, as a
// file or behind a plain http:// address (https can't be read yet).
//
//   address   host or host:port (port 7777 without). Required.
//   name      shown until the server answers with its own name.
//   featured  true puts it in the Featured section at the top.
//   note      one line from the list's keeper: region, who hosts it, when it restarts.
//
// (
//     servers: [
//         (address: "play.example.org", name: "Example co-op", featured: true, note: "EU, hosted by Example"),
//         (address: "203.0.113.7:7778"),
//     ],
// )
(
    servers: [],
)
```

</details>