Skip to main content

Start here

Where the files live​

Open Settings in Chattler, scroll to Plugins, and click Open plugins folder. Windows opens:

%APPDATA%\Chatter\plugins

Themes sit next to it:

%APPDATA%\Chatter\themes

Paste that path into the address bar of any Explorer window if you would rather not go through Settings.

Installing something​

  1. Save the file into the folder. Plugins end in .chatt, themes end in .theme.
  2. In Chattler, go to Settings and click Reload.
  3. A plugin appears in the list with a switch next to it. A theme appears in the theme gallery.

That is the whole install. There is no package manager, no account, and nothing is downloaded behind your back: a plugin is a file you put there on purpose.

Read before you run

A plugin cannot steal your login or touch your files, but it can still be annoying - wrong alerts, alerts at the wrong time, alerts about the wrong person. Read a script before you enable it. They are short and meant to be read.

Turning one on​

Every plugin has a switch in Settings → Plugins. Underneath it you will find:

  • its description, taken from the file
  • its settings, if it has any, which you can change without editing the file
  • Recent alerts, the last few things it said

Three plugins are on when you install Chattler: Repeat offender, AutoMod waiting and Suspicious user watch. The rest are there, switched off, ready when you want them.

Changing a built-in plugin​

The eight plugins that ship with Chattler are ordinary files too. To change one:

  1. Copy its text from Examples, or from resources\app.asar\src\plugins in your install folder.
  2. Save it into your own plugins folder with the same file name.
  3. Reload.

Your copy wins. The same goes for themes: a dark.theme in your themes folder replaces the built-in Dark.

When something is wrong​

A plugin that does not compile shows up in Settings with a red error tag and the line number, like:

Line 7: Expected "then", found "alert"

It stays switched off until it compiles. A plugin that keeps failing while it runs turns itself off after ten errors and tells you so, rather than filling your screen.

Sharing​

A plugin is one text file. Send it in Discord, paste it in a gist, put it in a forum post. Whoever gets it drops it in their folder and hits Reload.

If you want people to trust it, keep it short, say what it does at the top, and give the settings names that explain themselves.