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

# Config

## Sending alerts

```yaml
# The Updater Checker for new plugin updates.
updater:
  # Sends a reminder when the plugin is completely enabled.
  # Disabling won't send any reminder.
  on-start: true
  # Sends a reminder to OP's or players with 'sir.admin.update' permission.
  # Disabling won't send any reminder.
  send-op: true
```

### On start reminder

When the plugin loads up, you may get a reminder that the plugin is fully loaded and therefore usable.\
You can enable/disable this option anytime under `updater.on-start`.

### Send info to players with OP

When operators (OPs) or players with `sir.admin.update` permissions join your server, they will be informed in a chat by S.I.R.

To disable this, go to `updater.send-op` and set the value to `false`.

## Useful options

```yaml
# Some useful options for this plugin if you want to change them.
options:
  # It will log the join/quit messages, the announcements from announces.yml,
  # and the advancement messages from advances.yml to the server's console.
  send-console: true
  # If enabled, it will remove all unnecessary spaces for every chat message
  # to send. Recommended leaving this 'false'.
  strip-spaces: false
  # Fix a color format bug when RGB is applied to the console.
  # It's recommended to leave it to false if you don't have this visual bug.
  fix-logger: false
  # If enabled, it will check if the permission is set to that player,
  # overriding the default OP permission system.
  # In other words, it'll not check if a player is OP, only if a player
  # HAVE SET that specific permission, avoiding wildcard permissions,
  # like sir.* or worldedit.*. Recommended leaving this value on 'false'.
  override-op: false
  # if enabled, it will show the prefix of the message type in the console.
  # Example: [ACTION-BAR] My action bar message.
  show-prefix: true
```

### Send extra info to the console

Don't want to see join/quit messages, announcements or advancement messages? You can quickly disable them under `options.send-console`.

### Stripping spaces

Recommend to `false`, this will remove all unnecessary spaces in every chat message. You can enable this (but for your good, don't do this) under `options.strip-spaces`.

### Fix color formatting issues

Do you get a weird output of colors from S.I.R. in the console? Enable this option `options.fix-logger` to remove this problem.

### Check permission and bypass OP

This will only check if a player has permission that is needed for a specific action. We recommend leaving this option false as it can cause some serious security risks.

### View message prefix

Wanna know how the message is formatted in Minecraft? Leave this enabled so you can see if the message was sent for example in the action bar, in the title, etc.

## Prefixes for formatting

```yaml
# You can delete the values' section if you want to use the hard-coded values!
values:
  # Every message that start with this string, will have the main-prefix.
  lang-prefix-key: '<P>'
  # Valid only in SIR files or inputs that accept centered messages.
  # Put this first on those chat messages you want to center.
  center-prefix: '<C>'
  # Can be used in most of the plugin files and the /print command.
  # If you want to add more than one line in your CHAT type message, or you
  # want title AND subtitle, use it to split the message.
  line-separator: '<n>'
```

### What is this doing?

This option is left there for you if you want to change the prefix key of some formatting features in chat, messages and others. You can leave this as it is, because most of the time you will not use them, or you can't simplify them any more.


---

# 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://klema.gitbook.io/sir-docs/configure-the-plugin/config.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.