{"id":29857165,"url":"https://github.com/streamerbot/docs","last_synced_at":"2025-07-30T00:38:49.561Z","repository":{"id":203566103,"uuid":"709904597","full_name":"Streamerbot/docs","owner":"Streamerbot","description":"Official documentation for Streamer.bot","archived":false,"fork":false,"pushed_at":"2025-07-27T20:22:20.000Z","size":30298,"stargazers_count":16,"open_issues_count":8,"forks_count":100,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-07-27T22:16:54.914Z","etag":null,"topics":["docs","documentation","speakerbot","streamdeck-plugin","streamerbot","streaming","twitch-bot","youtube-bot"],"latest_commit_sha":null,"homepage":"https://docs.streamer.bot","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Streamerbot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"patreon":"nate1280"}},"created_at":"2023-10-25T16:14:47.000Z","updated_at":"2025-07-27T20:22:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"eb3c7561-54a0-404a-8111-a70ce2c3078c","html_url":"https://github.com/Streamerbot/docs","commit_stats":null,"previous_names":["streamerbot/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Streamerbot/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Streamerbot%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Streamerbot%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Streamerbot%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Streamerbot%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Streamerbot","download_url":"https://codeload.github.com/Streamerbot/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Streamerbot%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267785993,"owners_count":24144125,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","speakerbot","streamdeck-plugin","streamerbot","streaming","twitch-bot","youtube-bot"],"created_at":"2025-07-30T00:38:49.118Z","updated_at":"2025-07-30T00:38:49.552Z","avatar_url":"https://github.com/Streamerbot.png","language":null,"readme":"# Streamer.bot Documentation\n\n![Streamer.bot Docs](https://img.shields.io/badge/docs-streamerbot?label=Streamer.bot\u0026color=%239c59f1\u0026link=https%3A%2F%2Fdocs.streamer.bot)\n![Speaker.bot Docs](https://img.shields.io/badge/docs-speakerbot?label=Speaker.bot\u0026color=%239c59f1\u0026link=https%3A%2F%2Fspeaker.bot)\n![Discord](https://img.shields.io/discord/834650675224248362?logo=discord\u0026label=Discord\u0026color=rgb(82%2C%2094%2C%20235))\n![GitHub contributors](https://img.shields.io/github/contributors/Streamerbot/docs?logo=github\u0026label=Contributors)\n![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Streamerbot/docs/deploy-streamerbot.yml)\n\nOfficial home of all documentation content for [Streamer.bot](https://streamer.bot) and [Speaker.bot](https://speaker.bot)\n\n## Contributing\nContributions are welcome and encouraged!\n\nFeel free to open an issue to discuss missing information, or just fork and PR 💜\n\nGuidelines: TBA\n\n## MDC Components\n\nThe following are preconfigured `::callout` components:\n\n```\n::note\nThis is some useful information to callout\n::\n\n::tip\nThis is a cool tip!\n::\n\n::warning\nSome important info goes here\n::\n\n:read-more{to=\"/path/to/some/other/page\"}\n\n::wip\nThis content is a work in progress\n::\n```\n\n\n## Frontmatter\nSome docs will be automatically built out from YAML frontmatter\n\n### All\nAll pages should have a `title` and `description`.\n\nOptionally, if the release version of a feature is known, the `version` key should contain the Streamer.bot version it was added in.\n\n```yml\ntitle: Page Title\ndescription: Some description of this page\nversion: 0.2.3\n```\n\n### Sub-Actions \u0026 Triggers\nVariables, Parameters (e.g. Sub-Action dialog options), and C# Method sections can automatically be built from front matter keys:\n\n```yml [api/sub-actions/my-sub-action.md]\ntwitchService: Chat Client\nparameters:\n  - name: Game Title\n    type: Text\n    required: true\n    description: |\n      Enter the description for this parameter with full markdown support.\n\n      ::tip\n        It even supports mdc!\n      ::\n  - name: Some other parameter\n    type: Select\n    required: false\n    description: This is the description for some other parameter\nvariables:\n  - name: viewers\n    type: number\n    description: The amount of viewers this raid received\n    value: 183\ncommonVariables:\n  - TwitchUser\ncsharpMethods:\n  - UnbanUser\n  - BanUser\n```\n\n### C# Methods\nSupplemental information can be added to C# methods by adding a markdown file into the api/csharp/_methods directory with the **exact same name** as the C# Method:\n\n\n```md [_methods/SomeCsharpMethod.md]\n---\ndescription: The primary short description for SomeCsharpMethod\nversion: 0.2.3\nparameters:\n  - name: data\n    description: |\n      Data to be sent to connected clients\n\n      JSON must be stringified.\n    value: '\"Hello, world!\"'\n---\n\nSome extended description information\n```\n\n- `description` - Short description rendered **above** the resulting C# code block and included in SEO\n- `version` - Optional value representing the version of Streamer.bot that added this feature\n- `deprecated` - Optional value representing the version of Streamer.bot that deprecated this feature\n- `parameters` - Optional of parameter documentation\n    - `name` - The exact name of this parameter. **Must match the name from Streamer.bot**\n    - `description` - Any additional documentation or info to include with this parameter. **Markdown supported**\n    - `value` - An example C# value for this parameter. Will be used within the `CPH Example` code block and included in the `Copy` function\n    - `import` - Optionally import the parameter fields above from a file in the  _parameters dir (see below)\n\n### C# Parameters\nAdditionally, parameters information can be shared by referencing the name of any markdown or yaml file in the api/csharp/_parameters directory:\n\n```md [_methods/SomeCsharpMethod.md]\n---\nparameters:\n  - import: SomeSharedParameter\n---\n```\n\n```md [_paramters/SomeSharedParamter]\n---\nname: my_parameter\ndescription: |\n  Some long description\n\n  With extra info\n\n  That would be annoying to include in every file that uses this parameter 😉\nvalue: 0\n---\n```","funding_links":["https://patreon.com/nate1280"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreamerbot%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstreamerbot%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreamerbot%2Fdocs/lists"}