Files
openrig-world/registry/submissions/README.md
T
Mike Schwarz 3750c0dec6 registry: say when a submitted rig name is already taken (#43)
When a submission in registry/submissions/ uses a name that's already listed in registry/, the "Submission received" notice now adds: "That name is taken. Choose a distinct one, for example <name>-<your-name>." The match is case-insensitive and covers .yml too. The check still passes and its findings are unchanged; a maintainer helps if needed. registry/submissions/README.md says the same in one line.
2026-10-05 10:13:04 -07:00

821 B

Submissions

To submit a rig bundle for openrig.dev/rigs, open a pull request that adds one file here, <your-team>.yaml, with exactly these three fields:

repository: https://github.com/<owner>/<repo>
folder: rigs/my-team   # the folder holding rig.yaml; "." for the repository root
ref: main              # a branch, tag or commit

The registry check accepts it and says "Submission received". A maintainer then pins your link to an exact commit, reviews the bundle, writes the full entry in registry/, and removes this file. If it isn't listed, you get a short reply saying why.

Rig names on openrig.dev/rigs are unique. If registry/<your-team>.yaml already exists, the check still passes but says the name is taken; rename your file to a distinct one, for example <taken-name>-<your-name>.yaml.