{"id":16223136,"url":"https://github.com/zerebos/bdpluginlibrary","last_synced_at":"2025-05-16T06:07:08.084Z","repository":{"id":35080885,"uuid":"133907777","full_name":"zerebos/BDPluginLibrary","owner":"zerebos","description":"Plugin library for BetterDiscord.","archived":false,"fork":false,"pushed_at":"2025-02-20T18:18:39.000Z","size":5823,"stargazers_count":216,"open_issues_count":0,"forks_count":134,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-05-11T22:56:08.264Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zerebos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-05-18T05:36:42.000Z","updated_at":"2025-05-11T11:05:17.000Z","dependencies_parsed_at":"2023-02-14T00:16:04.493Z","dependency_job_id":"c4cf2a82-e7cd-4e2d-9508-6c696f1ab2a7","html_url":"https://github.com/zerebos/BDPluginLibrary","commit_stats":{"total_commits":198,"total_committers":18,"mean_commits":11.0,"dds":"0.16161616161616166","last_synced_commit":"3f321f9a3b21f3829277870068b98673ffd5c869"},"previous_names":["zerebos/bdpluginlibrary"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zerebos%2FBDPluginLibrary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zerebos%2FBDPluginLibrary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zerebos%2FBDPluginLibrary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zerebos%2FBDPluginLibrary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zerebos","download_url":"https://codeload.github.com/zerebos/BDPluginLibrary/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254478190,"owners_count":22077676,"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-10-10T12:17:31.294Z","updated_at":"2025-05-16T06:07:03.055Z","avatar_url":"https://github.com/zerebos.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e [!CAUTION]\n\u003e This library has reached end of life and is now considered deprecated and discontinued. It is recommended to convert over to using BetterDiscord's built-in API. If you find there are features missing, open a feature request in the BetterDiscord repository.\n\n# ZeresPluginLibrary - [Download](https://betterdiscord.app/Download?id=9) \n\nThis is the repo for Zere's Plugin Library for BetterDiscord. You can follow development here. There will be more info and shit to come, but for now here ya go.\n\n## Library Documentation\n\nView the library documentation here: [https://zerebos.github.io/BDPluginLibrary/docs](https://zerebos.github.io/BDPluginLibrary/docs)\n\nThe information below is just a quickstart guide and overview on using the build scripts provided.\n\n## Using The Library\n\nIf you'd like a real-world example, take a look at https://github.com/zerebos/BetterDiscordAddons\n\nFirst add the library builder to your repo:\n\n```bash\nnpm install zerespluginlibrary\n```\n\nThen add to your `package.json`:\n```json\n{\n    //...\n   \"scripts\": {\n    // ...\n       \"build\": \"zpl build\",\n       \"init\": \"zpl init\"\n   }\n   // ...\n}\n```\n\nCreate your ZPL config. You can use `.zplrc`, `.zplrc.js`, or a top-level `zplConfig` key in `package.json`;\n```js\n// .zplrc.js\nmodule.exports = {\n    base: \"./examples\",\n    out: \"./release\",\n    copyToBD: true,\n    addInstallScript: true\n};\n```\n\nInitialize your first plugin with:\n```bash\nnpm run init PluginName\n```\n\nYou should a new folder with an `index.js` and `config.json`. When you're ready to build, just run:\n```bash\nnpm run build PluginName\n```\n\nand a new `PluginName.plugin.js` will be created in your output folder.\n\n## Building The Lib\n\n```\nnpm install\nnpm run build\n```\n\nThis generates a BD compatible `./release/0PluginLibrary.plugin.js` file to be added to your plugins folder.\n\n### Configuration\n\nThe library is configurable with the default configuration found in the `package.json`.\n\n#### `releaseFolder`\nAbsolute or relative path to the folder where plugins that are built should be placed.\n\n**Default**: `\"./release\"`\n\n***\n\n#### `bdFolder`\nAbsolute or relative path to the BetterDiscord folder. Useful when combined with `copyToBD`. This folder is found automatically on most system.\n\n**Default**: `\"\u003cos-specific\u003e/BetterDiscord\"`\n\n***\n\n#### `copyToBD`\nBoolean to determine if the built plugin should also be automatically copied over to your BD plugins directory. Very convenient for development.\n\n**Default**: `false`\n\n***\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzerebos%2Fbdpluginlibrary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzerebos%2Fbdpluginlibrary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzerebos%2Fbdpluginlibrary/lists"}