docs: copy-paste examples for CommandGroup, conversations, and export - #13
Merged
Conversation
…port GitHub wiki is unpublished (SingularityLib.wiki 404). Put consumer examples under docs/examples/ verified against CommandGroup on main and DevTool rework/v2 at 72ff53e (ItemCreator(Plugin, …), ConversationFactory withModality(false), cancel escape). Co-authored-by: Nonnipat Tangrojjanakhajorn <contact@pinont.me>
Help, unknown-subcommand, and permission messages print the raw getName() string (e.g. arena:ar), not the first alias token. Co-authored-by: Nonnipat Tangrojjanakhajorn <contact@pinont.me>
Pinont
marked this pull request as ready for review
September 7, 2026 06:10
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.
GitHub wiki is unpublished (
Pinont/SingularityLib.wiki404s), so consumer examples live underdocs/examples/instead.What this adds
Copy-paste pages verified against current APIs:
docs/examples/command-group.mdCommandGroup/SubCommandon this repomaindocs/examples/conversations.mdStartConversation/PromptWorldInputat72ff53e(rework/v2, DevTool PR #1)docs/examples/export-snippets.mdItemSnippet.studioItemCreator/studioCustomItem—new ItemCreator(CorePlugin.getInstance(), Material.…)README Usage now points at
docs/examples/.API checks baked into the snippets
ItemCreator(Plugin, Material)(no Plugin-less ctor)ConversationFactory.withModality(false)+ escapecancelCustomItem.register()returns the builder;getInteraction()may benullAttributes.setAttributereturns a new stack (reassignment required)getName()(includingname:alias)Companion
In-game click paths: Singularity-DevTool PR #2 →
rework/v2(nevermain).Out of scope
release.ymlchangesreleaselabel (DevOps owns that)