Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AtomMaterialUI/mtslack

Customize your Slack experience with tweaks and themes. Includes the famous Material Themes as well as other popular themes such as Monokai Pro, Dracula, Atom One, GitHub, Solarized, Night Owl...
https://github.com/AtomMaterialUI/mtslack

atom-one dracula github material material-theme-ui material-theme-ui-plugin night-owl slack theme

Last synced: 7 days ago
JSON representation

Customize your Slack experience with tweaks and themes. Includes the famous Material Themes as well as other popular themes such as Monokai Pro, Dracula, Atom One, GitHub, Solarized, Night Owl...

Host: GitHub
URL: https://github.com/AtomMaterialUI/mtslack
Owner: AtomMaterialUI
License: apache-2.0
Archived: true
Created: 2019-08-02T14:50:57.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-09-27T18:58:19.000Z (about 1 month ago)
Last Synced: 2024-10-23T15:58:58.614Z (18 days ago)
Topics: atom-one, dracula, github, material, material-theme-ui, material-theme-ui-plugin, night-owl, slack, theme
Language: SCSS
Homepage: https://mallowigi.github.io/mtslack/
Size: 99.7 MB
Stars: 495
Watchers: 6
Forks: 23
Open Issues: 18
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# mtslack (Material Themed Slack)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

Beautify your Slack application from a list of popular themes!!!

# Deprecation notice

As Slack now blocked the ability to open DevTools, it's no longer possible to apply custom CSS to the Slack Window.

We had a good run, goodbye folks and thanks for the fish.

-------------

# Features

**Theme List**:

- Material Oceanic ![oceanic.png](doc/v2/oceanic.png)
- Material Darker ![darker.png](doc/v2/darker.png)
- Material Palenight ![palenight.png](doc/v2/palenight.png)
- Material Lighter ![lighter.png](doc/v2/lighter.png)
- Material DeepOcean ![deepocean.png](doc/v2/deepocean.png)
- Material Forest
- Material Sky Blue
- Material Sandy Beach
- Material Volcano
- Monokai Pro ![monokai.png](doc/v2/monokai.png)
- Arc Dark ![arcdark.png](doc/v2/arcdark.png)
- Dracula ![dracula.png](doc/v2/dracula.png)
- GitHub ![github.png](doc/v2/github.png)
- GitHub Dark ![github_dark.png](doc/v2/github_dark.png)
- Atom One Dark ![onedark.png](doc/v2/onedark.png)
- Atom One Light ![onelight.png](doc/v2/onelight.png)
- Solarized Dark ![solardark.png](doc/v2/solardark.png)
- Solarized Light ![solarlight.png](doc/v2/solarlight.png)
- Night Owl ![nightowl.png](doc/v2/nightowl.png)
- Light Owl ![lightowl.png](doc/v2/lighto``wl.png)
- Moonlight ![moonlight.png](doc/v2/moonlight.png)
- SynthWave '84

----------------------------

# Pledge

If you like this plugin, you can buy me a beer (or a coffee, or something else)
using [PayPal](https://paypal.me/mallowigi?locale.x=en_US)

You can also support this theme by subscribing to the
OpenCollective. [[Become a sponsor](https://opencollective.com/atom-material-themes-and-plugins#sponsor)]

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/atom-material-themes-and-plugins#backer)]

Check also :

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your
website. [[Become a sponsor](https://opencollective.com/atom-material-themes-and-plugins#sponsor)]

# Installation

### Global installation (only for Unix based systems)

**You will need node > 16 to use it.**

1. Run `npm install -g mtslack` in a terminal (or run `npx mtslack` if you don't want to install it globally)
2. Run the command `mtslack`
3. You will be prompted with a menu the following options:
- Copy code to clipboard
- Show plugin version

4. Select *Copy to clipboard* to copy the code snippet to your clipboard.
5. Slack will open in dev mode: `export SLACK_DEVELOPER_MENU=true; open -a /Applications/Slack.app`
6. Go to View -> Developer -> Toggle Dev Tools
7. In the Dev Tools Console tab, paste the code snippet
8. ?????
9. PROFIT!!!!!!!

----

### Troubleshooting

- I'm getting the following error after updating to version v25+:

```
internal/modules/run_main.js:54
internalBinding('errors').triggerUncaughtException(
^

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '/usr/local/lib/node_modules/mtslack/node_modules/chalk/source/node_modules/' imported from /usr/local/lib/node_modules/mtslack/node_modules/chalk/source/index.js
at packageMainResolve (internal/modules/esm/resolve.js:465:9)
at packageResolve (internal/modules/esm/resolve.js:607:14)
at moduleResolve (internal/modules/esm/resolve.js:659:14)
at Loader.defaultResolve [as _resolve] (internal/modules/esm/resolve.js:752:11)
at Loader.resolve (internal/modules/esm/loader.js:97:40)
at Loader.getModuleJob (internal/modules/esm/loader.js:242:28)
at ModuleWrap. (internal/modules/esm/module_job.js:50:40)
at link (internal/modules/esm/module_job.js:49:36) {
code: 'ERR_MODULE_NOT_FOUND'
```

-> That means you are using an older version of node. The plugin is now only compatible with ESM Modules, therefore
older versions are not supported.

Please update to node v16 and reinstall `mtslack`.

----

### Slack Tweaks

Since version 2.0 you can also profit from a bunch of **Slack Tweaks** to make the application more enjoyable. You can
find a button to open the Slack Tweaks on the channels sidebar.

#### Slack Tweak Control Panel

![Slack Tweaks](doc/v2/tweaksSettings.png)

This panel controls which tweak toggles are available. **This doesn't actually toggle the tweaks themselves!**.

Once you've enabled a tweak, a new toggle button will appear on the Channel Header. Pressing on these buttons will
activate the tweak.

You can also activate the toggle using a shortcut.

![Tweaks](doc/v2/tweaksToolbar.png)

These settings are saved in the application's Local Storage.

#### Highlight Code [NEW!] (Ctrl+Alt+H)

Automatically detects code blocks and highlight then using highlight.js. You can annotate the code blocks by setting the
language name as the first line.

Example: to annotate the code as a javascript code, write:

```
javascript
function foo() {
}
```

#### Modal Overlays (Ctrl+Alt+O)

This button will toggle an overlay to display whenever settings are open.

#### Dim Absent People (Ctrl+Alt+D)

This button will dim absent people from the sidebar, making the present ones more prominent.

#### Loop Over selected themes (Ctrl+Alt+T)

This button will loop over the available themes, allowing you to choose a theme in realtime.

#### Toggle Custom Font (Ctrl+Alt+F)

Switch the fonts used in the app with the font you've defined in the Slack Tweak Settings.

#### Toggle Custom Monospace Font (Ctrl+Alt+M)

Switch the monospace font size and family used in the app with the font you've defined in the Slack Tweak Settings.

#### Accent Color (Ctrl+Alt+A)

Switch the current theme's accent color with the one of your choice. You can set the desired color in the Slack Tweak
Settings.

#### Links Color (Ctrl+Alt+L)

Switch the current theme's links color with the one of your choice. You can set the desired color in the Slack Tweak
Settings.

#### Click to Edit

Double click on your messages to edit it. If you double click on other people's messages, it will copy it to clipboard.

#### Animations

Add animations to your Slack window.

----

# Development

## Building styles

This project consists in two parts:

- The CLI, used for applying the styles
- The Styles, written with Sass (Node-sass)

The cli is found in the `lib` directory while the styles are found in the `styles` directory.

Then run `npm run styles` or `npm run debugStyles` to compile the scss files in `dist/slack.min.css` or `dist/slack.css`

## Apply the styles

### Using the WebApp

Open Slack on the browser. It has the useful Developer Tools available to them so you can debug with ease.

To test your CSS, install a Stylish-like
extension ()
then create a new style for slack and paste the CSS inside and save.

You should already see all your styles applied. Please note that there are some differences between the web app and the
native app.

### Using the Electron app

1. Run `npm run server` to run a local server
2. Run `watchStyles` or `watchScripts` to watch for changes in styles or code
3. Run `npm run local` to run `apply` with the styles pointing to localhost
4. Run `npm run debug`

**IMPORTANT**: Please make sure to have enabled "Disable cache when devtools is open" in Chrome Settings.

Also don't forget to re-apply the production styles before quitting :)

----
Instead of launching Slack normally, you'll need to enable developer mode to be able to inspect things.

* Mac: `export SLACK_DEVELOPER_MENU=true; open -a /Applications/Slack.app`

* Windows: `export SLACK_DEVELOPER_MENU=true; ~/AppData/Local/slack.exe`

* Linux: Same as the others, but for Linux (depends whether installed from the Marketplace or from the Web)

# License

Apache 2.0

# Acknowledgements

Thanks to for the idea!

# License

Apache 2.0

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_Saghen
🐛🚇🎨

_{Danilo Resende}
🐛

_jlevier
🐛

_{Siddhesh Mhadnak}
🐛

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!