docs: document $SLSKD_SCRIPT_DATA JSON schema for all event types#1688
Open
cattz wants to merge 1 commit intoslskd:masterfrom
Open
docs: document $SLSKD_SCRIPT_DATA JSON schema for all event types#1688cattz wants to merge 1 commit intoslskd:masterfrom
cattz wants to merge 1 commit intoslskd:masterfrom
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
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
1 participant
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.
Summary
$SLSKD_SCRIPT_DATAenvironment variable passed to user-defined scriptsDownloadFileComplete,DownloadDirectoryComplete,UploadFileComplete,PrivateMessageReceived,RoomMessageReceived,SoulseekClientConnected,SoulseekClientDisconnectedTransferobject schema withTransferStatesflags reference tableContext
The existing docs mention
$SLSKD_SCRIPT_DATAand explain how to safely consume it, but don't document the actual JSON structure. This makes it difficult for external tools integrating via scripts (or webhooks) to parse the data without reading the source code.Test plan
ScriptService(usesJsonNamingPolicy.CamelCase+JsonStringEnumConverter)Transfer,PrivateMessage,RoomMessage, andEventsource types🤖 Generated with Claude Code