getting started

get doiksub installed and injected into ur discord in a few steps.

requirements

• node.js - v18 or later
• pnpm - used for package management
• discord desktop

winget install -e --id Discord.Discord.Development

windows - RunOnWindows.bat

the repo ships with a bat file that handles everything automatically. just double click it:

RunOnWindows.bat

it installs deps, builds doiksub and runs the installer.

manual install

1. 1
   clone the repo

   git clone https://github.com/ghxstprey/doiksub.git
   cd doiksub

2. 2
   install dependencies

   pnpm install --frozen-lockfile

3. 3
   build & inject

   pnpm build && node scripts/runInstaller.mjs -- --install

   add -auto to skip the manual injection prompt. useful for when you only have one install.

   pnpm build && node scripts/runInstaller.mjs -- --install -auto

4. 4
   restart discord

   fully quit and relaunch discord. doiksub should be active. if it isnt, fuck it all.

build & inject (quick ref)

pnpm install --frozen-lockfile
pnpm build && node scripts/runInstaller.mjs -- --install

scaffolding a new plugin

use the built in generator to scaffold a new plugin:

pnpm new-plugin myPluginName

this creates a new folder under src/plugins/myPluginName/ with a starter index.ts.

check the contributing page for plugin rules before u start.

repo structure (only the useful parts)