Skip to content

team-unstablers/SiriusProtocol

Repository files navigation

Mascot of the Sirius protocol, 'Sirius-kun'. An illustration of Sirius-kun standing with a confident expression. This illustration was drawn by Hoonkun (https://hoonkun.kiwi). Thank you!

The Sirius Protocol

The underlying protocol for Noctiluca

DRAFT NOTICE

This specification is still in draft stage and is being developed alongside Noctiluca, which is currently in early access. It is not yet recommended for production use.

  • Breaking changes may occur without prior notice. As Noctiluca evolves, the Sirius Protocol may undergo breaking changes accordingly.
    • We strive to maintain consistency, but backward compatibility is not guaranteed at this stage.
    • Commits that introduce or anticipate breaking changes will be prefixed with [BREAKING CHANGE] in the commit message subject line.

DRAFT VERSIONING POLICY

Since the specification has not yet reached a stable release, traditional semantic versioning is not used during the draft phase.

  • Tags are created when significant changes are made.
  • Tags follow the format draft-YYYYMMDD[-r{%d:rev}] (e.g., draft-20260321, draft-20260321-r2).

CONTRIBUTING

We welcome feedback and contributions! Here's how you can get involved:

  • Feedback: Please use the issue tracker to report bugs, suggest improvements, or ask questions about the protocol.
  • Pull Requests: PRs are always appreciated. However, please note that changes which diverge significantly from Noctiluca's current development direction may receive lower review priority. We appreciate your understanding.
  • Discord: Join the Noctiluca Discord server to discuss the Sirius Protocol with the community!

WRITING IMPLEMENTATIONS

Building your own implementation of the Sirius Protocol? We'd love to hear about it! Open an issue on the issue tracker when your implementation is public, and we'll be happy to link it from this repository.

CODE OF CONDUCT

Be respectful. Do not harass others or disparage competing products or their developers.

AUTHOR

  • @unstabler - Gyuhwan Park (team unstablers Inc.)

'SIRIUS-KUN' MASCOT ILLUSTRATION

  • @hoonkun - Gohoon Han (team unstablers Inc.)

LICENSE

This project is licensed under the MIT License. See the LICENSE file for details.

About

A multi-channel remote desktop protocol for multiplexed transports

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors