Skip to content

docs: Document v5 device config files and loading - #58

Closed
MadnessASAP wants to merge 1 commit into
buttplugio:masterfrom
MadnessASAP:part0-documentation-update
Closed

MadnessASAP wants to merge 1 commit into
buttplugio:masterfrom
MadnessASAP:part0-documentation-update

Conversation

@MadnessASAP

Copy link
Copy Markdown

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.

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>
@netlify

netlify Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for buttplug ready!

Name Link
🔨 Latest commit 15f1bea
🔍 Latest deploy log https://app.netlify.com/projects/buttplug/deploys/6abed1a59892c90008f74f14
😎 Deploy Preview https://deploy-preview-58--buttplug.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@CLAassistant

CLAassistant commented Oct 1, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@MadnessASAP

Copy link
Copy Markdown
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.

@qdot

qdot commented Oct 2, 2026

Copy link
Copy Markdown
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.

@qdot qdot closed this Oct 2, 2026
@qdot

qdot commented Oct 2, 2026

Copy link
Copy Markdown
Member

not particularly suited to being touched by end-users.

And yeah that's by design. Our device system is complex.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants