forked from Ittai/ittai
3.1 KiB
3.1 KiB
What the heck?! I only need to use one style for my plugin?
Ittai?! I only need to use Ittai for my plugin?
Ittai is a plugin bundler for most Discord client mods, making your plugin cross-compatible with multiple client mods easy!
Features | Installation | How to Build
Features
- Build even single-file BD plugins from multi-file projects.
- Write one codebase, run it anywhere.
- Hot rebuild your plugins.
- Use various flavors of JS to create your plugins.
- I didn't forget about CSS!
- Load your stylesheets easily.
import style from "./style.css";
- SASS (SCSS)
- Stylus
- LESS
- Load your stylesheets easily.
- Build to the most popular mods PRs adding more mod support accepted
Installation
Requirements
Installation Steps
From NPM
pnpm i -g @ittai/builder # this anywhere
pnpm i ittai # on your plugin's folder
From this repo (Building Ittai for local development)
git clone https://git.catvibers.me/Ittai/ittai
cd ittai
# linking the builder
cd builder
pnpm i
pnpm link --global
# linking the core
cd ..
cd core
pnpm i
pnpm link --global
Then, in your plugin's folder
pnpm link --global ittai
How to Build
Command Options
--plugin="path/to/your/plugin"
--betterdiscord
(optional)- Specify
="path/to/plugin/folder"
to copy the built file to the folder. - Builds for BetterDiscord.
- Specify
--powercordv2
(optional)- Specify
="path/to/plugin/folder"
to copy the built files to the folder. - Builds for Powercord v2.
- Specify
--goosemod
(optional)- Specify
="path/to/plugin/folder"
to copy the built files to the folder. - Builds for GooseMod.
- Specify
--watch
(optional)- Will watch for changes in your plugin's unbuilt files and automatically run the command again for you.
Build Command
This command will build your plugin for BetterDiscord, Powercord v2, and GooseMod, but will only copy it to BetterDiscord's plugins folder. It will also hot rebuild your plugin for you.
ittai --plugin="./test/plugin" --betterdiscord="/path/to/plugins/fgbd" --powercordv2="/path/to/plugins/fgbd" --goosemod-"/path/to/plugins/fgbd" --watch