Skip to content
 
 

Repository files navigation

Taut

Client mod for Slack :D

Quickstart

  • Desktop:
    • Windows: x64 / ARM
      • You may need to close Slack before installing
    • MacOS: Apple Silicon / Intel
      • Run before launching: xattr -d com.apple.quarantine /Applications/Taut.app
    • Linux: x64 / ARM
    • Runs separately from your normal Slack desktop app!
    • Cannot run at the same time as normal Slack
  • Userscript:
    • Requires Tampermonkey, no Safari
    • Set these settings in the Tampermonkey dashboard > Settings
      • General / Config mode: Advanced
      • (Chrome / Chromium-based only) Security / Content Script API: UserScripts API Dynamic
      • (Firefox only) Experimental / Inject Mode: Instant
    • Install the userscript
  • Browser extension:
    • Chrome / Chromium-based
      • Hopefully available in the Chrome Web Store soon
      • Extract the extension to a permanent location
      • Go to about:extensions, enable Developer mode, Load unpacked the extension folder
    • Firefox
      • Hopefully available on the Firefox Add-ons site soon
      • Until then, requires Firefox Developer Edition (or Nightly or another fork that allows unsigned extensions)
      • In about:config, set xpinstall.signatures.required to false
      • Install the extension

Join #taut on the Hack Club Slack!


Usage

Open Preferences > Taut for Taut settings:

  • Enable or disble plugins
  • Edit plugin config or user CSS
  • (Desktop only) You can also edit config or CSS in the config folder:
    • Windows: %APPDATA%\taut
    • macOS: ~/Library/Application Support/taut
    • Linux: ~/.config/taut
  • Desktop enables DevTools, press Ctrl+Alt+I or Cmd+Option+I

Change how Taut is loaded:

  • Loader:

    • Desktop
      • Menu (on Windows/Linux, press Alt to show) > Taut > Change app source...
    • Userscript
    • Extension
      • Manage Extension > Extension options/Preferences
  • Options:

    • Official - Normal build, always up-to-date
    • Official (sourcemaps) - Same as Official, but original .ts and .tsx files show up in DevTools for better debugging, ~250kb more
    • Dev server - Loads from bun dev running locally on localhost:3000
    • Embedded copy (only on custom embedded builds) - Loads the copy of Taut stored inside the loader

    user-plugins/ (the plugins/ directory is overwritten on update)

Development

Taut consists of a primary app (with plugins bundled inside) and different loaders (including desktop, the userscript, and the Chrome and Firefox extensions). An "embedded" loader contains a copy of the app bundle inside of it, otherwise it is loaded from taut.jer.app by default.

The project uses Bun for development (npm i -g bun if you need it). After installing and building everything (bun run build), output files will be in dist/. Desktop (much slower than everything else) is built separately with bun build:desktop [names...], where each name is a platform (win win-arm mac mac-x64 linux linux-arm, or all) and/or a variant (standard embedded), e.g. bun build:desktop mac win embedded.

PRs are very welcome! You should join the #taut channel on the Hack Club Slack (13-18yo only). I'm @Jeremy, say hi :D

See also

Other Slack tools from the Hack Club community that may interest you:

  • Rope by Ani (#rope) - Client mod, userscript, similar Webpack patching
  • Slick by Rowan - Client mod, desktop app, DOM modifications
  • Snail by Alice (#snail) - Client mod, patches MacOS app, React monkeypatching

Credits

License

MIT License


AI use disclaimer: I've used plenty of AI in the creation of this project, but all the code is closely reviewed and high-quality. If not for this disclaimer, you probably wouldn't be able to tell lol, this is probably the project I am most proud of ever making.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages