Dedicated Server API

All endpoints are accessible via this API as a NotAuthenticated, however any FRM Endpoints that require authentication will rely on FRM’s Authentication Token to be passed in the request header. Please refer to the respective endpoint documentation for more information. This is a design choice by the FRM Development Team to establish a standard for all endpoints.

This is not the case with the FRM Web Server, which uses a separate thread to execute most requests. Please note that some requests may still use the GameThread to execute, such as the getPlayer endpoint to obtain some, if not all, of the data for the respective endpoint.

We cannot change this behavior, as it is how the game is designed. The FRM Development Team has tried to make all of FRM’s Endpoints as efficient as possible. However, larger requests, such as getFactory, may still cause minor hiccups in the Dedicated Server’s performance.

Smaller saves/worlds will not experience this issue as much as larger saves/worlds. This mod is routinely tested on saves with 1000+ hours of playtime and 10000+ items in the factory. However, please note that this is not a guarantee that you will not experience any issues. Special thanks to BLAndrew575 for his save for testing.

Here is an example request using Powershell 7’s Invoke-WebRequest: Similiar request can also be made by curl

```
Invoke-WebRequest -Uri https://localhost:7777/api/v1 -Method POST -ContentType application/json -Body '{"function": "frm", "endpoint": "getPlayer"}' -SkipCertificateCheck

StatusCode        : 200
StatusDescription : OK
Content           : [{"ID":"Char_Player_C_2146409224","Name":"","ClassName":"Char_Player_C","location":{"x":-258596.109
                    375,"y":-48086.0078125,"z":439.743896484375,"rotation":353.14453212390106},"Online":false,"PlayerHP
                    ":…
RawContent        : HTTP/1.1 200 OK
                    Server: FactoryGame/++FactoryGame+rel-main-1.1.0-CL-415558
                    Server: (Windows)
                    Keep-Alive: timeout=15.000000
                    Content-Type: application/json; charset=utf-8
                    Content-Disposition: inlin…
Headers           : {[Server, System.String[]], [Keep-Alive, System.String[]], [Content-Type, System.String[]],
                    [Content-Disposition, System.String[]]…}
Images            : {}
InputFields       : {}
Links             : {}
RawContentLength  : 1522
RelationLink      : {}
```

The example below is for getting the list of players on the server. Please see the respective endpoint documentation for examples of their JSON response.

```json
{
    "function": "frm",
    "endpoint": "getPlayer"
}
```

This example is for using the sendChatMessage endpoint to send a message to the server as well as the response.

Request:
```json
{
    "function": "frm",
    "endpoint": "sendChatMessage",
    "data":
    {
        "message": "Hello World :)"
    }
}
```

Response:
```json
{
    "IsSent": true,
    "Message": "Hello World :)"
}
```