> For the complete documentation index, see [llms.txt](https://docs.sirecstudio.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sirecstudio.com/ss-documents.md).

# SS-Documents

<figure><img src="/files/Epz3KryTLIKPOyZ5limu" alt=""><figcaption></figcaption></figure>

#### Overview

**SS-Documents** is an advanced system for managing official documents in RedM, designed to enhance roleplay experiences. As an extension of **SS-IdentityCard**, it allows creation, signing, and sharing of various legal documents like certificates, licenses, and statements. This plugin integrates seamlessly into roleplay, offering a Western-themed UI and realistic features for both lawful and unlawful scenarios. **SS-IdentityCard** is needed for operation.

#### Features and Functionality

* **Unlimited Document Creation**: Players can create customizable documents with titles, subtitles, and detailed sections.
* **Fillable Fields**: Input boxes, dates, and text areas that auto-save upon signing.
* **Job-Based Document Access**: Restrictions based on roles via the AllowedDocs config.

#### Document Creation System

Documents are job-restricted:

* **Governor**: Pardon Certificates, Political Affiliation forms.
* **Police**: Firearm Licenses.
* **Mayors**: Marriage, Employment, Divorce Documents.

#### Predefined Categories & Documents

Custom access categories:

* **Public**: Statements, reports, denunciations.
* **Police**: Firearm Licenses.
* **Mayor**: Sales declarations, debt notices.
* **Marshal**: Search Warrants.
* **Governor**: Political Certificates, Pardons.

#### Immersive UI & Features

* **Western UI**: Handwritten appearance for documents.
* **Translations Available**: Document categories and descriptions.
* **In-Game Navigation**: Menu for showing/viewing documents to/from nearby players.

#### Fully Configurable

* **Customization Options**: Document content, job permissions, category settings.
* **Configurable Items**: Example item like cocoa can initiate document creation.
* **Server-Side Saving**: Document status updates upon successful server save.


---

# 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://docs.sirecstudio.com/ss-documents.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.
