# Arma Reforger

***Server version currently marked as early access by the Arma developers! Check back often for egg updates as more features are added to the server software.***
___

## Authors / Contributors

<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
    <tr>
        <td align="center">
            <a href="https://github.com/lilkingjr1">
                <img src="https://avatars.githubusercontent.com/u/4533989" width="50px;" alt=""/><br /><sub><b>Red-Thirten</b></sub>
            </a>
            <br />
            <a href="https://github.com/parkervcp/eggs/commits?author=lilkingjr1" title="Codes">💻</a>
            <a href="https://github.com/parkervcp/eggs/commits?author=lilkingjr1" title="Maintains">🔨</a>
        </td>
        <td align="center">
            <a href="https://github.com/Soljian">
                <img src="https://avatars.githubusercontent.com/u/4036453" width="50px;" alt=""/><br /><sub><b>Soljian</b></sub>
            </a>
            <br />
            <a href="https://github.com/parkervcp/eggs/commits?author=Soljian" title="Contributor">💡</a>
        </td>
    </tr>
</table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->

___

### Game Description

From Bohemia Interactive's [Website](https://reforger.armaplatform.com/):
> Experience authentic Cold War combat and join friends in the struggle for a sprawling, 51 km² mid-Atlantic island — or take on the role of Game Master and create your very own scenarios for others to enjoy.
___

### Egg Capabilities

- Configurable to automatically check for server updates on start via SteamCMD. Forcing validation is also configurable.
- Able to download and load Arma Reforger Workshop mods on startup (requires manual editing of the `config.json` file).
- Configuration of multiple common settings in the `config.json` file via Startup Parameters:
  - Server Name, Passwords, Scenario ID, Disable Third Person, Max FPS, and more...
- Max Players is configurable and able to be host enforced (\*see [Recommended Egg Modifications](#restrict-max-players)).
- [WHMCS](https://www.whmcs.com/) compatible.

___

### Server Ports

| Port | Default | Protocol | Required | Notes |
|---------|---------|---------|---------|---------|
| **Game** | 2001 | UDP | **Yes** | Primary port in Panel |
| A2S | 17777 | UDP | No | Steam Query / Requires additional configuration in `config.json` |
| RCON | 19999 | UDP | No | Requires additional configuration in `config.json` |

___

### Installation/System Requirements

|  | Bare Minimum | Recommended |
|---------|---------|---------|
| Processor | Recent x86/64 (AMD/Intel) processor. No ARM support. | Can use up to 300-600% CPU under load with uncapped FPS (set Max FPS to prevent). |
| RAM | 3328 MiB | 6144-8192 MiB |
| Storage | 5 GB | 7-10 GB (or more, depending on number of mods downloaded) |
| Network | If node is behind a NAT, will require Egg Modification (\*see [Define Host Registered Bind Address](#define-host-registered-bind-address) | Wings Node is not behind a NAT |
| Game Ownership | Not required to start or download mods. | ---- |

___

### How to Add Mods

Currently, adding mods to your server is tricky because there is very little documentation and it is difficult to find mod IDs. Hopefully this will change in the future, but following these steps will get it to work:

1. Open up a client copy of Arma Reforger and subscribe/download any mods you want to add to the server (at this time, I do not know of a way to find mod IDs without requiring use of the game).
2. Once done, close the game and navigate to this folder on your computer: `My Documents\My Games\ArmaReforger\addons\`
3. Aimlessly open each folder to find which mods you want to add and open each of their `ServerData.json` files in a text editor.
4. Then, on your server panel, open the `config.json` file for editing.
5. Find `"mods": []` and replace it with the following:

```json
"mods": [
	{
		"modId": "591AF5BDA9F7CE8B",
		"name": "Capture & Hold",
		"version": "1.0.0"
	},
	{
		"modId": "9A51598BACFBFDE7",
		"name": "Explosive Goats Beta",
		"version": "0.5.42"
	}
]
```

6. Change `modId` to equal the `id` value found at the top of the `ServerData.json` file you found.
7. Change `name` to equal the `name` value found at the **top** of the `ServerData.json` file you found.
8. Change `version` to equal the `version` value found at the top of the `ServerData.json` file you found.
9. Repeat for each mod you want to add by copy/pasting the `{}` sections like shown above. Make sure each `{}` section has a `,` after it, **except** for the last item.

The server will automatically download and run the mods you specify on startup. For mods that add scenarios, you can find the Scenario IDs listed as `gameId` in the `ServerData.json` file. Lastly, if a mod updates, you will likely have to change the `version` value to match it's new version. You may also have to delete the mod folder in the `addons/` directory to have it re-download (reports on this have been mixed).

___

### Recommended Egg Modifications

The following are highly recommended variable modifications you can make to the egg after importing it to your panel.

#### Define Host Registered Bind Address

Due to a current behavior of the Panel, `SERVER_IP` will not return the node's public IP address if it is behind a NAT; it will return its private IP address. Unfortunately at this time, Arma Reforger **requires** the server's public IP address to be strictly defined within `config.json`. If you know your node is behind a NAT (or you are finding your node's private IP address being added to `config.json`), you will need to edit this egg after importing it by following these steps:

1. As a panel admin, find and open the egg within your Nests tab.
2. On the first tab "Configuration", find the "Configuration Files" box under the "Process Management" section.
3. Carefully (as to not touch anything else), find `{{server.build.default.ip}}` and replace it with your node's public IP address. If done correctly, the line should now look something like this:

```json
"publicAddress": "123.4.56.789",
```

#### Restrict Max Players

If you would like to restrict the maximum number of players that can join your client's server, you can change the permissions of the "Max Players" variable so that clients can only view this value (and not edit it). It's default value can also be changed, or the value can be changed on a server-by-server basis as desired.
