{"id":20297054,"url":"https://github.com/briochie/heralda-voice-plugin","last_synced_at":"2025-05-07T20:33:45.987Z","repository":{"id":170462957,"uuid":"147374274","full_name":"briochie/Heralda-voice-plugin","owner":"briochie","description":"Heralda's voice, in plugin form.","archived":true,"fork":false,"pushed_at":"2020-03-20T23:14:13.000Z","size":19,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-04T05:43:36.127Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/briochie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2018-09-04T16:17:32.000Z","updated_at":"2023-08-14T19:37:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"9d5f5f52-79fb-4039-925e-f61df8b2d2e6","html_url":"https://github.com/briochie/Heralda-voice-plugin","commit_stats":null,"previous_names":["briochie/heralda-voice-plugin"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briochie%2FHeralda-voice-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briochie%2FHeralda-voice-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briochie%2FHeralda-voice-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briochie%2FHeralda-voice-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/briochie","download_url":"https://codeload.github.com/briochie/Heralda-voice-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252953716,"owners_count":21830890,"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","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":[],"created_at":"2024-11-14T15:43:22.574Z","updated_at":"2025-05-07T20:33:45.966Z","avatar_url":"https://github.com/briochie.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Heralda, the helpful Discord Herald Bot\n\n[Heralda](https://github.com/EbekFrostblade/Heralda-chat-bot) is a chat bot that announces the arrival of new users to voice channels in Discord. She uses voicerss.org to retrieve text-to-speech voice clips, which she then plays in the voice channel.\n\n## This Component\n\nThis is Heralda's main voice plugin. It can serve as an example to create your plugins to tie into her API.\n\n## Configuration\n\nYou can configure the voice plugin by changings your `_config.json` file in your Heralda root directory:\n\n```javascript\n{\n  \"token\": \"[DISCORD TOKEN]\",\n  \"plugins\": {\n    \"heralda-voice-plugin\": {\n      \"commands\": {\n        //\"[COMMAND NAME]\": \"[INPUTS, IN, AN, ARRAY]\"\n      },\n      \"messages\": {\n        //\"[MESSAGE NAME]\": \"[MESSAGE TEXT]\"\n      },\n      \"voice\": {\n        \"apiKey\": \"[VOICE-RSS KEY]\" //plus additional audio settings\n      }\n    }\n  }\n}\n\n```\n\nThe only required keys is the `voice.apiKey`. Everything else inherits from the default values.\n\n### Commands\n\n#### summon\n\nThis summons Heralda to your current connected voice channel. You must send her a message in a public room in the same server you and her are connected to, and you must @mention her.\n\nThe default commands are `get in here` and `you've been summoned`.\n\n#### dismiss\n\nThis asks Heralda to leave the voice channel she is in. As with summoning her, you must send this message in a public channel for the server she is connected to, and you must @mention her.\n\nThe default commands are `get out of here` and `dismissed`.\n\n### Messages\n\n#### summoned\n\nThe text Heralda speaks when she enters a voice channel.\n\n#### memberConnected\n\nThe templated string for the text Heralda speaks when a user connects to her voice channel. You can use the template `{name}`, and she will insert that user's nickname into the text (or username if they have no nickname).\n\n#### memberDisconnected\n\nThe templates string for when the user leaves Heralda's voice channel. Like with memberConnected, you can pass `{name}` to have her insert the user's nickname/username into the line.\n\n### errors\n\nThese are not spoken, but instead typed into the chat channel where the command was issued in response to requests.\n\n#### memberNotInAVoiceChannel\n\nWhat Heralda replies with when the user is not in a voice channel.\n\n#### alreadyInMemberschannel\n\nWhat Heralda replies when she is already in the summoning user's voice channel.\n\n### Voice\n\nThese values all map to request variables for the voice-rss API. For more information, you can check out their [documentation](http://www.voicerss.org/api/documentation.aspx).\n\n#### apiKey - required\n\nThis is your voice-rss key. Keep this secret!\n\n#### language\n\nThe voice you wish to use, based on language. For language values, check the documentation link above.\n\n#### speakingSpeed\n\nThe speed (rate) at which you want Heralda to speak her lines. The values range from -10 (slowest) to 10 (fastest).\n\n#### codec\n\nThe speech audio codec. Check the documentation for accepted values.\n\n#### format\n\nFormat for the audio transmitted. Once again, check out their documentation.\n\n#### ssml\n\nThe SSML textual content format. Can be true or false.\n\n#### base64\n\nIf you would like the output to be a Base64 string, which according to their documentation is used for browser playback. Not supported by this plugin, but I still expose the option to change this value if you wish.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbriochie%2Fheralda-voice-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbriochie%2Fheralda-voice-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbriochie%2Fheralda-voice-plugin/lists"}