# Yonexus.Protocol

This repository contains the **shared communication protocol specification** for the Yonexus system.

It is referenced as a git submodule by both `Yonexus.Server` and `Yonexus.Client`.

## Contents

- `PROTOCOL.md` — full protocol specification
- `src/types.ts` — shared builtin envelope / payload TypeScript definitions
- `src/index.ts` — package export surface
- Canonical JSON shape references

## Purpose

Yonexus is a cross-instance communication system for OpenClaw, split into:
- `Yonexus.Server` — the central hub plugin
- `Yonexus.Client` — the client plugin
- `Yonexus.Protocol` — the shared protocol definition

Both server and client implementations must conform to the protocol defined in this repository.

## Version

Current protocol version: **draft v0.3**

## References

- [Yonexus umbrella repository](https://git.hangman-lab.top/nav/Yonexus)
- [Yonexus.Server](https://git.hangman-lab.top/nav/Yonexus.Server)
- [Yonexus.Client](https://git.hangman-lab.top/nav/Yonexus.Client)