> For the complete documentation index, see [llms.txt](https://nexeum.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nexeum.gitbook.io/docs/dutylogs/installation.md).

# Installation Guide

In order for dutylogs to work, [nex-duty](https://nexeum-studios.tebex.io/package/6794438) is required to be installed and setup in your server. This is a standalone resource that we created, but doubles up as the integration resource between your server and dutylogs. Once you have nex-duty setup, the installation process for dutylogs is very simple. 

In `config/server_config.lua:`

1. Set the `Server_Config.State` value to `hosted`
2. Insert your servers Private API Key into `Server_Config.API_KEY`

As of right now, the site utilises the `image_url` value in each entities configuration in `Config.Entities` in the `config/shared_config.lua`. You must include a `.png` image url for each entity, otherwise the entity (department) images on dutylogs will be blank.

If you want to use the Live Map feature, in `config/shared_config.lua:`

1. Set the `Config.LiveMap` value to `true`
2. If you only want on-duty units to have access to the live map, set the `Config.RestrictLiveMap` value to true

Once you've completed those steps, restart the resource and the script will connect to dutylogs.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://nexeum.gitbook.io/docs/dutylogs/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.