If you found a bug, please:
- Fork the
main
branch. - Install dependencies
pnpm install
. - Run local dev server with
pnpm dev
. - Test your bug fix locally.
- Submit a Pull Request.
And if all is well, your pull request will be merged.
If you're a theme dev and wish to have your theme on the editor, follow these intructions:
All files are TypeScript (
.ts
) and everything you require is fully typed.
-
Fork the
main
branch. -
Install dependencies
pnpm install
. -
Run local dev server with
pnpm dev
. -
Make a new dev file inside the
src/data/devs
file with your name ending in.ts
.
Inside the dev file, import theDeveloper
type get all available properties.
Create a constant variable that has the type ofDeveloper
, then export it as the default.This can be a
var
orlet
but we're not going to edit it during the runtime.import type { Developer } from '$types/dev'; const dev: Developer = { name: 'coolDev', github: 'coolDev' }; export default dev;
If a property is required but not present, you'll get a warning from your editor.
-
Make a new theme file inside
src/data/themes
file with your theme name ending in.ts
.
Inside the theme file, import theTheme
type to get all available properties.
Create a constant variable that has the type ofTheme
, then export it as the default.import type { Theme } from '$types/theme'; const theme: Theme = { name: 'Cool Theme', thumbnail: 'https://direct.link/to-thumbnail.jpg', meta: {}, // BetterDiscord META variables: [] // Theme config that users will edit. // more properties... }; export default theme;
The
Theme
config is quite large, so make sure you read all the inbuilt documentation, which should tell you all you need to know.
You also can view other theme files to see how they do it. -
Inside the
src/data/themes/index.ts
file, import your theme and add it to the themes array.import coolTheme from './coolTheme.ts'; export const themes = [ // themes... coolTheme ];
-
Submit a Pull Request. If all is well, your theme will be merged.