Repository navigation
docs: Document v5 device config files and loading - #58
Closed
MadnessASAP wants to merge 1 commit into
Closed
MadnessASAP wants to merge 1 commit into
MadnessASAP wants to merge 1 commit into
Conversation
Rewrite the device configuration file page for the v5 format. The DCF sections now point developers at the per-protocol YAML sources and document the protocol file layout, communication specifiers, feature outputs and inputs, and the keys the loader accepts but ignores. The UDCF sections steer DIY users to the tcode-v03 protocol, with examples for a serial device, a Websocket Device Manager device, and a configuration adding a second axis. Device customizations, simulated devices, how both files are loaded, how devices are matched to definitions, and what is merged versus replaced are documented too. Keep the existing cautions, and add new ones for the format being a work in progress, undocumented keys becoming errors, UDCF configurations not being saved back, devices keeping their original definition, and message_gap_ms replacing rather than inheriting. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
✅ Deploy Preview for buttplug ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This was referenced Oct 1, 2026
Author
|
I will be the first to admit that the documentation here is a little confusing, occasionally contradictory, and downright not ready for end-user consumption. However!! I will also say that Buttplugs handling of configuration files is a little confusing, occasionally contradictory, and believe-it-or-not, not particularly suited to being touched by end-users. |
Member
|
Oh yeah. Repo rule: Our documentation is never AI generated. Ever. Period. Code, maybe, docs, no. I will at least take a look at it to see what info you included but I guard the docs hard. |
Member
And yeah that's by design. Our device system is complex. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In conjunction with buttplugio/buttplug#963
Part of intiface/intiface-central#290
Rewrite the device configuration file page for the v5 format. The DCF sections now point developers at the per-protocol YAML sources and document the protocol file layout, communication specifiers, feature outputs and inputs, and the keys the loader accepts but ignores.
The UDCF sections steer DIY users to the tcode-v03 protocol, with examples for a serial device, a Websocket Device Manager device, and a configuration adding a second axis. Device customizations, simulated devices, how both files are loaded, how devices are matched to definitions, and what is merged versus replaced are documented too.
Keep the existing cautions, and add new ones for the format being a work in progress, undocumented keys becoming errors, UDCF configurations not being saved back, devices keeping their original definition, and message_gap_ms replacing rather than inheriting.