25 lines
1 KiB
Markdown
25 lines
1 KiB
Markdown
|
# CollabVM 3 Protocol
|
||
|
|
|
||
|
|
Current Version: v0.0
|
||
|
|
|
||
|
|
These files make up the Protocol Buffers-based messages that the CollabVM 3 server sends.
|
||
|
|
|
||
|
|
**NOTICE**: The protocol is currently not in a released state, so it can/will change. Do not rely on it being the same or compatible in this stage of development.
|
||
|
|
|
||
|
|
# Protocol Versions
|
||
|
|
|
||
|
|
We will release a major version bump *every time* we make a change (once we have released v1.0) to the protocol that will break older clients (by replacing/removing fields or other protobuf breaks). Non-breaking changes will be a minor version bump.
|
||
|
|
|
||
|
|
Despite the fact Protobuf has data format stability guarantees, we allow breaks on purpose, since if a hacky workaround has to be made, it's probably time for a version bump.
|
||
|
|
|
||
|
|
|
||
|
|
## Protocol Documentation
|
||
|
|
|
||
|
|
### Convention
|
||
|
|
|
||
|
|
All given pieces of the protocol are neatly organized into individual `collabvm.proto.[X]` packages.
|
||
|
|
|
||
|
|
This is to make it a lot less convoluted to work with.
|
||
|
|
|
||
|
|
This may make it a bit harder to build protobufs for but IMO it's better than not caring.
|