orchetect/osckit

Open Sound Control ([OSC](https://opensoundcontrol.stanford.edu)) library written in Swift for Apple platforms, Linux, and Android.

Getting Started

The library is available as a Swift Package Manager (SPM) package.

Use the URL https://github.com/orchetect/OSCKit when adding the library to a project or Swift package.

See the getting started guide for a detailed walkthrough of how to get the most out of OSCKit.

The Examples folder also contains projects to quickly get started.

Documentation

See the online documentation or view it in Xcode's documentation browser by selecting the Product → Build Documentation menu.

This includes a getting started guide, links to examples, and troubleshooting tips.

Dependencies

CocoaAsyncSocket is used by the OSCKit target for network sockets (Apple platforms only).
swift-ascii is used for ASCII string and character formatting and validation.
swift-data-parsing is used for binary data decoding.

Author

Coded by a bunch of 🐹 hamsters in a trenchcoat that calls itself @orchetect.

License

Licensed under the MIT license. See LICENSE for details.

Sponsoring

If you enjoy using OSCKit and want to contribute to open-source financially, GitHub sponsorship is much appreciated. Feedback and code contributions are also welcome.

Community & Support

Please do not email maintainers for technical support. Several options are available for issues and questions:

Questions and feature ideas can be posted to Discussions.
If an issue is a verifiable bug with reproducible steps it may be posted in Issues.

Contributions

Contributions are welcome. Posting in Discussions first prior to new submitting PRs for features or modifications is encouraged.

Code Quality & AI Contribution Policy

In an effort to maintain a consistent level of code quality and safety, this repository was built by hand and is maintained without the use of AI code generation.

AI-assisted contributions are welcome, but must remain modest in scope, maintain the same degree of quality and care, and be thoroughly vetted before acceptance.

Package Metadata

Repository: orchetect/osckit

Default branch: main

README: README.md