diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..da9ca47 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,49 @@ +name: Build and deploy + +on: + push: + branches: [master] + +jobs: + deploy: + runs-on: ubuntu-latest + permissions: + contents: write + + steps: + - uses: actions/checkout@v3 + + - name: Prepare environment + uses: actions/setup-node@v3 + with: + node-version: "16" + + - run: npm install --global pnpm + + - name: Install deps + run: pnpm m i + + - name: Build plugin(s) + run: node ./build.mjs + + # Foolproof feature: + # - Copies over README so that the root of the deployed website shows it + # - Changes 404 page to README so that you don't get lost while clicking links + # If you remove this step then you should probably remove the enable_jekyll option in the next one + - name: Copy additional files + run: | + cp README.md dist/README.md + printf -- "---\npermalink: /404.html\n---\n" > dist/404.md + printf -- "> **Note:** You accessed a link that returned a 404, probably by clicking one of the plugin links. You're supposed to copy the link address and add it into Vendetta.\n\n" >> dist/404.md + cat README.md >> dist/404.md + + # Documentation: https://github.com/peaceiris/actions-gh-pages + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./dist + # Makes it so the md files in the previous step get processed by GitHub Pages + enable_jekyll: true + # This creates the CNAME file required to host GitHub Pages on a custom domain + # cname: example.com diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..adc4bff --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +node_modules/ +dist/ +pnpm-lock.yaml +yarn.lock +package-lock.json \ No newline at end of file diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..c483022 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +shamefully-hoist=true \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..670154e --- /dev/null +++ b/LICENSE @@ -0,0 +1,116 @@ +CC0 1.0 Universal + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator and +subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later +claims of infringement build upon, modify, incorporate in other works, reuse +and redistribute as freely as possible in any form whatsoever and for any +purposes, including without limitation commercial purposes. These owners may +contribute to the Commons to promote the ideal of a free culture and the +further production of creative, cultural and scientific works, or to gain +reputation or greater distribution for their Work in part through the use and +efforts of others. + +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with a +Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or her +Copyright and Related Rights in the Work and the meaning and intended legal +effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not limited +to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, communicate, + and translate a Work; + + ii. moral rights retained by the original author(s) and/or performer(s); + + iii. publicity and privacy rights pertaining to a person's image or likeness + depicted in a Work; + + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + + v. rights protecting the extraction, dissemination, use and reuse of data in + a Work; + + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation thereof, + including any amended or successor version of such directive); and + + vii. other similar, equivalent or corresponding rights throughout the world + based on applicable law or treaty, and any national implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and +unconditionally waives, abandons, and surrenders all of Affirmer's Copyright +and Related Rights and associated claims and causes of action, whether now +known or unknown (including existing as well as future claims and causes of +action), in the Work (i) in all territories worldwide, (ii) for the maximum +duration provided by applicable law or treaty (including future time +extensions), (iii) in any current or future medium and for any number of +copies, and (iv) for any purpose whatsoever, including without limitation +commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes +the Waiver for the benefit of each member of the public at large and to the +detriment of Affirmer's heirs and successors, fully intending that such Waiver +shall not be subject to revocation, rescission, cancellation, termination, or +any other legal or equitable action to disrupt the quiet enjoyment of the Work +by the public as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be +judged legally invalid or ineffective under applicable law, then the Waiver +shall be preserved to the maximum extent permitted taking into account +Affirmer's express Statement of Purpose. In addition, to the extent the Waiver +is so judged Affirmer hereby grants to each affected person a royalty-free, +non transferable, non sublicensable, non exclusive, irrevocable and +unconditional license to exercise Affirmer's Copyright and Related Rights in +the Work (i) in all territories worldwide, (ii) for the maximum duration +provided by applicable law or treaty (including future time extensions), (iii) +in any current or future medium and for any number of copies, and (iv) for any +purpose whatsoever, including without limitation commercial, advertising or +promotional purposes (the "License"). The License shall be deemed effective as +of the date CC0 was applied by Affirmer to the Work. Should any part of the +License for any reason be judged legally invalid or ineffective under +applicable law, such partial invalidity or ineffectiveness shall not +invalidate the remainder of the License, and in such case Affirmer hereby +affirms that he or she will not (i) exercise any of his or her remaining +Copyright and Related Rights in the Work or (ii) assert any associated claims +and causes of action with respect to the Work, in either case contrary to +Affirmer's express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + + b. Affirmer offers the Work as-is and makes no representations or warranties + of any kind concerning the Work, express, implied, statutory or otherwise, + including without limitation warranties of title, merchantability, fitness + for a particular purpose, non infringement, or the absence of latent or + other defects, accuracy, or the present or absence of errors, whether or not + discoverable, all to the greatest extent permissible under applicable law. + + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without limitation + any person's Copyright and Related Rights in the Work. Further, Affirmer + disclaims responsibility for obtaining any necessary consents, permissions + or other rights required for any use of the Work. + + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to this + CC0 or use of the Work. + +For more information, please see + diff --git a/README.md b/README.md new file mode 100644 index 0000000..b3e2a25 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# Vendetta Plugins Template +This repo contains a template for creating [Vendetta](https://github.com/vendetta-mod/Vendetta) plugins. + +# How to install? +Paste a plugin URL into the Plugins page of Vendetta, following a basic format of: + +https://`YOUR_GITHUB_USERNAME`.github.io/`REPO_NAME`/`PLUGIN_NAME` \ No newline at end of file diff --git a/build.mjs b/build.mjs new file mode 100644 index 0000000..0e1e081 --- /dev/null +++ b/build.mjs @@ -0,0 +1,88 @@ +import { readFile, writeFile, readdir } from "fs/promises"; +import { extname } from "path"; +import { createHash } from "crypto"; + +import { rollup } from "rollup"; +import esbuild from "rollup-plugin-esbuild"; +import commonjs from "@rollup/plugin-commonjs"; +import nodeResolve from "@rollup/plugin-node-resolve"; +import swc from "@swc/core"; + +const extensions = [".js", ".jsx", ".mjs", ".ts", ".tsx", ".cts", ".mts"]; + +/** @type import("rollup").InputPluginOption */ +const plugins = [ + nodeResolve(), + commonjs(), + { + name: "swc", + async transform(code, id) { + const ext = extname(id); + if (!extensions.includes(ext)) return null; + + const ts = ext.includes("ts"); + const tsx = ts ? ext.endsWith("x") : undefined; + const jsx = !ts ? ext.endsWith("x") : undefined; + + const result = await swc.transform(code, { + filename: id, + jsc: { + externalHelpers: true, + parser: { + syntax: ts ? "typescript" : "ecmascript", + tsx, + jsx, + }, + }, + env: { + targets: "defaults", + include: [ + "transform-classes", + "transform-arrow-functions", + ], + }, + }); + return result.code; + }, + }, + esbuild({ minify: true }), +]; + +for (let plug of await readdir("./plugins")) { + const manifest = JSON.parse(await readFile(`./plugins/${plug}/manifest.json`)); + const outPath = `./dist/${plug}/index.js`; + + try { + const bundle = await rollup({ + input: `./plugins/${plug}/${manifest.main}`, + onwarn: () => {}, + plugins, + }); + + await bundle.write({ + file: outPath, + globals(id) { + if (id.startsWith("@vendetta")) return id.substring(1).replace(/\//g, "."); + const map = { + react: "window.React", + }; + + return map[id] || null; + }, + format: "iife", + compact: true, + exports: "named", + }); + await bundle.close(); + + const toHash = await readFile(outPath); + manifest.hash = createHash("sha256").update(toHash).digest("hex"); + manifest.main = "index.js"; + await writeFile(`./dist/${plug}/manifest.json`, JSON.stringify(manifest)); + + console.log(`Successfully built ${manifest.name}!`); + } catch (e) { + console.error("Failed to build plugin...", e); + process.exit(1); + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..189b00e --- /dev/null +++ b/package.json @@ -0,0 +1,26 @@ +{ + "private": true, + "scripts": { + "build": "node build.mjs" + }, + "dependencies": { + "@swc/helpers": "^0.4.14" + }, + "devDependencies": { + "@rollup/plugin-commonjs": "^24.0.0", + "@rollup/plugin-node-resolve": "^15.0.1", + "@swc/core": "^1.3.35", + "esbuild": "^0.16.14", + "rollup": "^3.9.1", + "rollup-plugin-esbuild": "^5.0.0", + "vendetta-types": "latest" + }, + "pnpm": { + "peerDependencyRules": { + "ignoreMissing": [ + "react", + "react-native" + ] + } + } +} diff --git a/plugins/template/manifest.json b/plugins/template/manifest.json new file mode 100644 index 0000000..7ae52d5 --- /dev/null +++ b/plugins/template/manifest.json @@ -0,0 +1,14 @@ +{ + "name": "Template Plugin", + "description": "A plugin for use as a template.", + "authors": [ + { + "name": "You!", + "id": "YOUR_ID_HERE" + } + ], + "main": "src/index.ts", + "vendetta": { + "icon": "ic_badge_staff" + } +} \ No newline at end of file diff --git a/plugins/template/src/Settings.tsx b/plugins/template/src/Settings.tsx new file mode 100644 index 0000000..004df79 --- /dev/null +++ b/plugins/template/src/Settings.tsx @@ -0,0 +1,8 @@ +import { Forms } from "@vendetta/ui/components"; +const { FormText } = Forms; + +export default () => ( + + Hello, world! + +) \ No newline at end of file diff --git a/plugins/template/src/index.ts b/plugins/template/src/index.ts new file mode 100644 index 0000000..03bd39a --- /dev/null +++ b/plugins/template/src/index.ts @@ -0,0 +1,12 @@ +import { logger } from "@vendetta"; +import Settings from "./Settings"; + +export default { + onLoad: () => { + logger.log("Hello world!"); + }, + onUnload: () => { + logger.log("Goodbye, world."); + }, + settings: Settings, +} \ No newline at end of file diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml new file mode 100644 index 0000000..2a603e8 --- /dev/null +++ b/pnpm-workspace.yaml @@ -0,0 +1,2 @@ +packages: + - plugins/* \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..936e53c --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,12 @@ +{ + "compilerOptions": { + "outDir": "dist", + "target": "ESNext", + "module": "ESNext", + "moduleResolution": "node", + "esModuleInterop": true, + "jsx": "react-native", + "allowJs": true + }, + "include": ["plugins", "node_modules/vendetta-types"] +}