slick README

项目的 README,来自 github.com/3kh0/slick。合并为一个 markdown 文件:README.md。

Logo
Slick

The coolest Slack client mod for MacOS, Windows, and Linux

GitHub Release GitHub Downloads (all assets, all releases) GitHub Repo stars

[!CAUTION] This is in early alpha and may not even be allowed by Salesforce. Expect breakage, bugs, and random crashes. The information here may be inaccurate or incomplete, but the code is open source and you can inspect it yourself.

screenshot

Slick runs Slack's own app.asar inside its own Electron (with the handy BYOE acronym, bring your own electron). Slick's code runs before Slack's bundle and patches Slack from the inside, through its module system, React, and Redux. Slack's files are never altered, both apps keep updating, and there's no open debug port or resident watcher. This means we are able to patch Slack in a fast and safe way, while still keeping Slack's own updates and security intact.

Features

Installation

Slick is widly available on platforms all shapes and sizes. Just scroll down to your platform and follow the instructions.

Web

Reload Slack in your browser after installing for the changes to take effect.

macOS

With Homebrew (macOS 13+, Apple Silicon or Intel):

brew install --cask 3kh0/tap/slick

If you already have Slack installed or do not want to use Homebrew, you can also install Slick via this one-liner:

curl -fsSL https://raw.githubusercontent.com/3kh0/slick/main/install.sh | bash

For Slack elsewhere, add -s -- --slack-app "/path/to/Slack.app" after bash. You can also download the .dmg from the latest release and drag Slick to Applications. From the files, pick mac-arm64 for Apple Silicon and mac-x64 for Intel based Macs.

If you are not using the homebrew tap, you'll also need Slack from slack.com in /Applications/Slack.app. The App Store version won't work!!

Windows

Install Slack first (the Microsoft Store version works too), then paste this into PowerShell:

irm "https://raw.githubusercontent.com/3kh0/slick/main/install.ps1" | iex

The installer picks the build that matches your Slack install and sets everything up for you nicely.

Linux

On x86_64, install Slack first. The ARM64 AppImage and Flatpak download their own Slack bundle on first launch.

Fedora (x86_64), using COPR. Install Slack's .rpm from slack.com first (Fedora's repos don't carry Slack):

sudo dnf install ./slack-*.x86_64.rpm
sudo dnf copr enable echolive/slick
sudo dnf install slick

Flatpak (x86_64 or ARM64):

flatpak install --user https://3kh0.github.io/slick/dev.slick.Slick.flatpakref

Open Slick from your app menu, or run flatpak run dev.slick.Slick.

Nix (x86_64 only):

nix run github:3kh0/slick

Arch (x86_64):

Choose one of the following AUR packages:

(Both AUR packages maintained by @Hash-AK)

Other distros: grab an AppImage, .deb or .rpm from the latest release. For an AppImage, make it executable in its file properties and open it.

Other installers, uninstalling and building from source

Linux installer (x86_64, with Slack installed):

curl -fsSL https://raw.githubusercontent.com/3kh0/slick/main/install-linux.sh | bash

Uninstall: use your package manager (brew uninstall --cask slick, sudo dnf remove slick, or flatpak uninstall --user dev.slick.Slick). For manual macOS installs, drag Slick to the Trash. For the Windows and Linux scripts:

& ([scriptblock]::Create((irm https://raw.githubusercontent.com/3kh0/slick/main/install.ps1))) -Uninstall
curl -fsSL https://raw.githubusercontent.com/3kh0/slick/main/install-linux.sh | bash -s -- --uninstall

The Windows and Linux scripts keep your sign-in and settings unless you add -Purge / --purge. To return slack:// links to Slack, use -RestoreHandler / --restore-handler. For Flatpak, use xdg-mime default dev.slick.Slick.desktop x-scheme-handler/slack if browser sign-in opens the wrong app.

Build from source: clone this repo and run ./install.sh (macOS), ./install-linux.sh (Linux), or powershell -ExecutionPolicy Bypass -File install.ps1 (Windows). Plugins live in src/plugins/<Name>/.

Updates

Slick will try to update itself every few hours. If you want to check by hand, use Slick > Check for Updates.... On macOS and standalone Windows it also keeps Slack itself up to date. On Linux arm64, Slick pins the downloaded Slack bundle to its release and downloads a new pin when Slick updates. The Microsoft Store, the deb and rpm packages, Flatpak and Nix update through their own package managers instead. Running through the installer again will also get you the latest version if it somehow breaks.

Themes

Import a .json theme from Slick Preferences > Appearance > Import theme JSON (or Appearance in the Firefox toolbar popup). Imported themes are saved, selected immediately, and can be picked again from the theme list or removed with Remove imported theme. A theme with "mode" only applies while Slack is in that color mode, so the built-in dark themes step aside in Light mode to prevent any weird looking colors.

The themes/ folder has all of the built-in themes. Adding files there won't load them into an installed app, so you will want to use the import button instead. Please use use this format:

{
  "name": "Super cool epic theme",
  "mode": "dark", // optional: "dark" or "light"; omit to apply in both
  "palette": { "highlight1": { "100": "139,92,246" } }, // --dt_color-plt-<ramp>-<shade>, raw "r,g,b"
  "sidebar": { "nav-bg": "#1A1525" }, // --p-team_sidebar__<key>
  "vars": { "--any-css-var": "value" }, // overrides
  "css": "selector { prop: val !important; }", // raw css (string or array)
}

Prefer to write your own CSS instead? Open the CSS editor in Slick Preferences (or the Custom CSS field in Firefox). It accepts raw CSS, which applies on top of your selected theme. JSON theme files belong in Import theme JSON, not the CSS editor. Choose Custom CSS only to use your CSS without a theme.

Credits

Licensing

This is under the GNU General Public License v3.0. See the LICENSE file for the legal mumbo jumbo. In short: just don't be a dick. If you're not sure what that means, see choosealicense.com/licenses/gpl-3.0. This code is provided to you for free, use at your own risk. I am not responsible for any harms due to the code here. Don't sue me.

Privacy

Slick uses data only to provide the plugins, themes and settings you choose. Slick does not run an analytics service, sell data, use data for advertising, or send Slack messages to the Slick developers.

The extension reads the Slack client to customize its interface. Depending on enabled plugins, it processes messages, profile information, user/channel identifiers and activity. MessageLogger keeps bounded local message deletion/edit history; LastSeen keeps local activity records. Settings, CSS, imported themes and plugin records stay in the browser profile. CustomFonts and CustomSounds store files you select locally. Disabling a plugin stops its activity but does not automatically erase its saved data. Plugin controls can clear history where provided; uninstalling the extension removes its extension storage. Plugin logs and ordinary preferences are not encrypted by Slick; access depends on your browser and operating system protections. AccountSwitcher stores session cookies and workspace tokens in a separate extension-private IndexedDB vault encrypted with AES-GCM and a non-extractable key. The key stays in the same browser profile; this is not password or operating-system keychain protection. Credentials are not synced, exported or exposed to the Slack-page bridge.

AccountSwitcher requests optional cookies, browsingData and https://*.slack.com/* access only when you enable session access in its account manager. It verifies sessions with Slack’s auth.test endpoint and never sends credentials to Slick servers. A switch pauses normal Slack tabs, replaces the profile’s Slack session cookies and clears cached client data, including unsent drafts. Saved accounts can be removed in the manager; disabling the plugin does not delete them. Private windows and Firefox containers are not switched.

InstalledApps requests optional https://*.slack.com/* access when you turn it on in the extension's Plugins tab. It uses that access only to read an app's slack.com/marketplace page with your Slack session, and keeps just the user IDs, names and channel IDs it shows.

User plugins are opt-in and left out of the Firefox Add-ons version. The extension requests the optional userScripts permission only when you click Allow user plugins in its Plugins tab (Chromium also needs Allow User Scripts turned on in the extension's details). Plugin files you choose stay in the extension's local storage and run only on app.slack.com; Slick never downloads plugins or sends them anywhere. The Plugins tab lists every installed plugin and removes it along with its saved data.

Optional external services: BetterGifs sends GIF search queries to tenor-proxy.vercel.app (Tenor) or api.klipy.com (KLIPY, with your own API key), and GIF images load from the provider’s media hosts; ClearURLs downloads JSON tracking-parameter rules from raw.githubusercontent.com; HCA Status sends Slack user IDs to auth.hackclub.com and reads verification/age-category results; Private Channel Mapper sends channel IDs or exact channel names to flaron.halceon.dev when its external-lookup settings are enabled. These services receive ordinary request metadata such as your IP address and follow their own privacy practices. Slack continues to handle your normal Slack traffic under its own policies. CSS you enter can also request resources you reference in it.

For privacy questions, use the project's issues page; do not include private Slack messages, credentials or local browser-profile data in public reports.

slick (3kh0/slick)

正在搜索数据库…

122 ·GitHub
这是什么?Slick 是一个用于 Slack 的客户端模组,它会修补 Slack 桌面应用和网页版客户端,以添加插件、自定义主题和其他界面调整,同时屏蔽 Slack 自身的遥测功能。
这是一个单独的桌面应用,还是会修改我现有的 Slack 安装?在桌面端,Slick 会在其自带的 Electron(即 BYOE,“自带 Electron”)中运行 Slack 自己的 app.asar,并通过其模块系统、React 和 Redux 从内部修补 Slack,而不是编辑 Slack 的文件。在网页端,它以浏览器扩展或 Violentmonkey 用户脚本的形式提供。
我该如何安装 Slick?安装方式因平台而异:macOS 可通过 Homebrew tap 或下载的 .dmg 安装,Windows 通过 PowerShell 单行命令安装,Linux 可通过 AppImage、Flatpak、COPR、AUR 或 .deb/.rpm 安装,浏览器则可通过 Chrome 网上应用店、Firefox 的 .xpi 文件或 Violentmonkey 用户脚本安装。
我需要先安装 Slack 吗?需要。对于大多数桌面端安装方式,您需要先从 slack.com 下载官方 Slack 应用(而非 App Store 版本);只有 Linux ARM64 的 AppImage 和 Flatpak 会自动下载各自的 Slack 组件包。
现在使用它安全又稳定吗?不。这是早期的 alpha 测试版软件,README 警告可能出现故障、漏洞和随机崩溃,并指出它甚至可能不被 Salesforce 允许使用。
Slick 会收集我的数据吗?Slick 本身不运行任何分析程序,也不出售数据,并会屏蔽 Slack 自身的遥测功能;但部分可选插件(BetterGifs、ClearURLs、HCA Status、Private Channel Mapper)仅在您启用它们时,才会向第三方服务发送特定数据。
Slick 与 Taut 或 Rope 等其他 Slack 模组相比如何?Slick 的插件数量最多(39 个,而 Taut 为 33 个,Rope 为 8 个),支持使用 Cookie 登录桌面端(其他两者不支持),并会同时自动更新自身和 Slack,而且会完全屏蔽遥测功能,而不只是替换它。
我可以编写自己的插件或主题吗?可以。插件可以用 JavaScript 或 TypeScript 编写,并存放在 src/plugins/ 目录中;主题可以从内置主题中选择,也可以在内置的 Monaco 编辑器中编写自定义 CSS,或导入 JSON 主题文件。
我能否不打开浏览器就登录 Slack?可以。Slick 可以直接使用您的 Slack "d" Cookie 为您登录,这对沙盒环境中的安装特别方便。
Slack 更新应用后,Slick 还能继续正常工作吗?可以。Slick 会自动更新自身和 Slack,并会通过 GitHub 构建证明来校验下载内容;但对于 Flatpak 或 Nix 等包管理器安装方式,则由各自的系统进行更新。
作者
3kh0
大小
10.3 MB
星标
122
时长
5个月
提交 · 90 天