> For the complete documentation index, see [llms.txt](https://striga.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://striga.gitbook.io/docs/striga-chat/exports-and-events/server.md).

# Server

Server exports and events of Striga Chat.

## Exports

| Export                        | What it does                                                    |
| ----------------------------- | --------------------------------------------------------------- |
| `addMessage(message)`         | Sends a line to everyone                                        |
| `addMessage(target, message)` | Sends a line to one player (`-1` = everyone)                    |
| `registerMessageHook(hook)`   | Lets you see, change or stop chat messages before they are sent |
| `registerMode(modeData)`      | Adds a chat mode                                                |

```lua
exports.chat:addMessage(source, { args = { 'Bank', '$500 received' } })
exports.chat:addMessage({ args = { 'Server', 'Restart in 5 minutes' } }) -- everyone
```

### registerMessageHook

```lua
exports.chat:registerMessageHook(function(source, outMessage, hookRef)
    -- hookRef.updateMessage({ ... })  change the message
    -- hookRef.cancel()                stop it
    -- hookRef.setSeObject(object)     only players with this ACE get it
    -- hookRef.setRouting(target)      send it to these players
end)
```

### registerMode

```lua
exports.chat:registerMode({
    name = 'staff',
    displayName = 'Staff',
    color = '#f43f5e',
    seObject = 'striga.chat.staff', -- optional ACE
    cb = function(source, outMessage, hookRef) end,
})
```

Returns `false` when the name is taken by a Striga Chat channel.

***

## Events

### chatMessage

Fires on the server for every chat message. Cancel it to stop the message.

```lua
AddEventHandler('chatMessage', function(source, author, text)
    if text:find('badword') then
        CancelEvent()
    end
end)
```

Unknown `/commands` go through `chatMessage` first, so old chat commands still work. If nobody cancels, the player gets "Unknown command".

{% content-ref url="/pages/sxyunuJfDkWtaKHjfRgl" %}
[Troubleshooting & FAQ](/docs/striga-chat/troubleshooting-and-faq.md)
{% endcontent-ref %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://striga.gitbook.io/docs/striga-chat/exports-and-events/server.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.