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

# Packages Directory

Shared packages used by the apps live here.

| Package     | Purpose                                                                                              | README                        |
| ----------- | ---------------------------------------------------------------------------------------------------- | ----------------------------- |
| `protocol/` | Shared FactionOS event and domain contracts used by server, web, hooks, adapters, Worker, and tests. | `protocol/README_protocol.md` |

`packages/protocol` is the first stop for cross-package event, mission, hero, plan, notice, achievement, scroll, faction, and War Room type changes. Apps should import shared contracts from `@factionos/protocol` instead of duplicating event or model shapes.

Phase 05 War Room contracts live in `packages/protocol/src/warroom.ts`. Worker and web code must continue to use those shared room, participant, error, socket, safe-frame, and blocked-field shapes before accepting or sending room data.

Keep package APIs small, typed, and framework-independent.


---

# 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://faction-os.gitbook.io/faction-os-docs/packages/readme_packages.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.