Skip to content

SacredTexts/vencord-spelling-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BetterSpellcheck

The plugin that's truly spell-binding.

"To spell, or not to spell -- that is the question. Whether 'tis nobler in the mind to suffer the red squiggles of outrageous spellcheck, or to take arms against a sea of false corrections..." -- William Shake-spell, probably

Enhanced spellchecking for Discord via Vesktop/Vencord with built-in internet slang dictionary, custom word lists, multi-language support, and a language importer that would make Webster himself say "poggers."


Comic: The Great Dictionary Import
The Sunday Funnies: Issue #1 -- The Great Dictionary Import


What It Does (No Spell-ief Required)

Discord's built-in spellchecker is powered by Hunspell -- a fine fellow, but absolutely clueless about modern internet culture. It sees "poggers" and panics. It sees "bussin" and has a breakdown. It underlines "ngl" like you just committed a grammatical felony.

BetterSpellcheck adds 1,500+ curated words to the spellchecker so you can finally type without your chat looking like a crime scene of red squiggles. It's un-spell-ievable how much better it is.


Comic: The Red Squiggly Nightmare
The Sunday Funnies: Issue #2 -- Night of the Living Squiggles


Features (The Whole Spell-bang)

  • Built-in Slang Dictionary -- 1,500+ internet slang, Discord, gaming, streaming, and tech terms. We've got you covered from "afk" to "yeet." That's the alpha and the omega of internet speak.
  • Custom Word Management -- Add words one at a time (for the patient), bulk paste (for the efficient), or import from files (for the over-a-chievers). Supports .txt, .json, .dic, and .csv.
  • Language Importer -- Import from legendary sources:
    • English Oxford Dictionary -- For when you want to sound Oxford-ly impressive
    • English Merriam-Webster Dictionary -- Because you Merriam-ly need comprehensive coverage
    • English Slang Dictionary -- 1,500+ terms so Discord stops having a conniption over "bruh"
    • English Full-Stack Programmer Dictionary -- Every framework, library, and API term known to modern web dev. From useState to kubectl, we speak fluent developer.
  • Import/Export -- Export your word list and share it. Spread the word, literally.
  • Multi-language Support -- Configure multiple spellcheck languages (e.g. en-US,ja,fr). We're very multi-lingual about this.
  • Settings Panel -- A full UI for managing your dictionaries. It's a real pane in the glass -- wait, no, it's actually quite nice.
  • Debug Tools -- Peek under the hood at Electron's custom dictionary. For the spell-unkers among you.

Comic: BetterSpellcheck Saves The Day
The Sunday Funnies: Issue #3 -- A Hero Rises (From the npm Registry)


Dictionary Categories (A Vocab-ulary of Variety)

The built-in slang dictionary covers a word-ld of categories:

Category Examples Pun Tax
Internet Slang lol, brb, afk, ngl, tbh, lowkey, highkey, bussin Abbreviation nation, no cap
Discord Terms pfp, nitro, emote, slowmode, permaban, modmail It's a Dis-cord-ial relationship
Gaming gg, nerf, buff, dps, mmr, ragequit, speedrun, poggers Game, set, match
Streaming vod, collab, hype, subgoal, donos, facecam Stream of consciousness
Tech Jargon api, cdn, regex, repo, backend, fullstack, kubectl Terminal-ly useful
Modern Slang rizz, slay, mid, sus, goated, stan, yeet No cap, this slaps
Abbreviations afaik, fwiw, imho, imo, tl;dr, eli5, iykyk If you know, you know
Frameworks nextjs, vite, tailwind, webpack, prisma, drizzle The full stack attack

Installation (Spell It Out For Me)

Prere-quiz-ites

  • Vesktop or Discord with Vencord installed from source
  • Git and Node.js (the dynamic duo)

Steps (A Spell-by-Spell Guide)

  1. Navigate to your Vencord source directory:

    cd /path/to/Vencord/src
  2. Create the userplugins folder if it doesn't exist (don't worry, mkdir won't judge you):

    mkdir -p userplugins
  3. Copy the BetterSpellcheck folder into userplugins:

    cp -r /path/to/BetterSpellcheck userplugins/BetterSpellcheck

    Your folder structure should look like this masterpiece:

    Vencord/src/userplugins/BetterSpellcheck/
    ├── index.tsx          # The brain (renderer process)
    ├── native.ts          # The muscle (Electron main process)
    ├── slangDictionary.json   # The vocabulary (1,500+ words)
    └── README.md          # You are here (it's punny in here)
    
  4. Build Vencord (compile-ments to the chef):

    cd /path/to/Vencord
    pnpm build
  5. Restart Discord/Vesktop. (Turn it off and on again. IT Crowd-approved.)

  6. Go to Settings -> Plugins -> search for BetterSpellcheck -> Enable it and letter rip!


Comic: The Full-Stack Framework Dictionary
The Sunday Funnies: Issue #4 -- The Framework Whisperer


Configuration (Fine-Tuning Your Spell-o-Meter)

In the plugin settings:

Setting Default Description
Enable Slang Dictionary On Load the built-in 1,500+ word slang dictionary. Highly recom-mend-ed.
Enable Custom Words On Load your saved custom word list. Your words, your rules.
Spellcheck Languages en-US Comma-separated language codes. Go multi-ling-wild.
Show Notifications On Get notified when dictionaries load. Word on the street.

Adding Custom Words (DIY Diction-airy)

Single Word

Type a word in the "Add Custom Word" field and press Enter. One small step for a word, one giant leap for your vocabulary.

Bulk Add

Paste a list separated by commas, semicolons, or newlines. The more, the Merriam-Webster.

Import from File

Click "Import from File" and select your format of choice:

  • Text files (.txt): One word per line, or delimited. Plain and simple, like good prose.
  • JSON files (.json): Array or object format. For the data-driven linguist.
  • DIC files (.dic): Hunspell format. The OG dictionary file.
  • CSV files (.csv): Comma-separated values. Spreadsheet warriors, unite.

External Dictionary Sources

You can import comprehensive word lists from these sources. It's like a word buffet:

  • dwyl/english-words -- 370,000+ English words. That's a lot of Scrabble ammunition.
  • SCOWL -- Spell Checker Oriented Word Lists. The name says it all, and it's not frowning.
  • 12dicts -- Curated from 12 published dictionaries. A dozen-ary delight.

Note: Electron's Hunspell spellchecker already includes a standard English dictionary. You typically only need to import words it doesn't know -- slang, proper nouns, framework names, and that one word you definitely didn't make up.

How It Works (Under the Spell-hood)

The plugin uses Electron's built-in spellchecker APIs, running a two-process architecture:

  • native.ts (Electron main process) -- Has direct access to session.addWordToSpellCheckerDictionary() and friends. This is where the spell-casting happens.
  • index.tsx (Renderer process) -- Provides the UI, settings panel, and dictionary management. The front-end of the dictionary.
  • DataStore -- Custom words persist across restarts via Vencord's storage. Your words are safe. We spell-ieve in data integrity.

Troubleshooting (When Spell Goes Wrong)

Words still showing as misspelled after adding:

  • Some words need a Discord restart. Patience, young Padawan-tionary.
  • Make sure the plugin is enabled and the dictionary setting is on.

Spellcheck not working at all in Vesktop:

  • Right-click the chat input and ensure "Spellcheck" is checked. Check the checkbox. It's not a trick question.
  • Linux users may need hunspell dictionary packages installed.

Multi-language not working on Linux:

  • Install the hunspell packages: sudo apt install hunspell-fr hunspell-de
  • Language codes use xx-XX format (e.g. fr-FR, de-DE, ja). Parlez-vous spellcheck?

License

GPL-3.0-or-later. Free as in speech, free as in beer, free as in "finally, no more red squiggles."


Made with love, puns, and an unreasonable number of dictionary files.
BetterSpellcheck -- Because every word deserves to be understood.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors