aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 6f335be3f48d47d00587b4d33e3d45ebde23519f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# ScudCloud - Linux Client for Slack

![ScudCloud Logo](/scudcloud-1.0/resources/scudcloud.png?raw=true "Scud clouds are low, ragged and wind-torn cloud fragments, usually not attached to the thunderstorm base. With the 'mother' cloud, the form of them together is like a chat balloon")

ScudCloud is a **non official** open-source Linux (Debian, Ubuntu, Kubuntu, Mint, Arch) desktop client for [Slack©](http://slack.com).

[Slack©](http://slack.com) is a platform for team communication.

ScudCloud uses the [QT](http://qt-project.org) library + [Webkit](http://www.webkit.org/) to render the web version of Slack, but using the [QWebkit-Native bridge](http://qt-project.org/doc/qt-4.8/qtwebkit-bridge.html) to improve desktop integration with:

* multiple teams support,
* native system notifications,
* count of unread direct mentions at launcher/sytray icon,
* alert/wobbling on new messages,
* channels quicklist (Unity only),
* optional "Close to Tray".

# Install

Please, first update your system with a `sudo apt-get update && sudo apt-get upgrade`. If not, ScudCloud will crash with some old components.

Then, to install it under **Ubuntu/Kubuntu** 14.04, 14.10, **Mint** and **Debian**, open a Terminal (Ctrl+Alt+T) and run:

```term
sudo apt-add-repository -y ppa:rael-gc/scudcloud
sudo apt-get update
sudo apt-get install scudcloud
```

If you want **spell checking** (it'll only mark wrong words in red, but no suggestions), add the `hunspell` dictionary for your language. For `en-us`:

    sudo apt-get install hunspell-en-us

If you want to use a Slack icon instead of ScudCloud (which is not impossible to include in this package due copyright), download [any 128px Slack icon](https://www.google.com.br/search?q=slack+icon&tbm=isch&source=lnt&tbs=isz:ex,iszw:128,iszh:128) to your home folder saving as `scudcloud.png` and run:

```term
sudo dpkg-divert --add --rename --divert /opt/scudcloud/resources/scudcloud.png.real /opt/scudcloud/resources/scudcloud.png
sudo cp ~/scudcloud.png /opt/scudcloud/resources/
```

## Ubuntu 12.04

For Ubuntu 12.04 (Precise Pangolin), **additionally** you'll need to update `qtwebkit`: Slack is not compatible with `libqtwebkit4` package shipped with 12.04, hanging in the `Loading` screen. Please add the following PPAs (for updated `qtwebkit`):

```term
sudo add-apt-repository -y ppa:immerrr-k/qtwebkit4-backport
sudo apt-get update
```

## Arch Linux

There is a [PKGBUILD available][pkgbuild] on the Arch User Repository. You can install it
using whichever AUR method you use. For instance, if you use cower:

```term
cower -d scudcloud
cd scudcloud
makepkg -si
```

[pkgbuild]: https://aur.archlinux.org/packages/scudcloud/

## Fedora 21

There is a yum repository available for Fedora 21. All you need to do is follow [these instructions][build_suse].

[build_suse]: http://software.opensuse.org/download.html?project=home%3Amoonwolf%3Ascudcloud&package=scudcloud

## Manual Install

The manual install is intended for not supported distros (if you want to contribute with a package for your distro, you're welcome!).

First, you'll need to install at least packages for `python3`, `python-qt4` (`qt4` for `python3`) and `python-dbus` (`dbus` library for `python3`).

Then run the below script: it'll download the code and install it:

```bash
wget https://github.com/raelgc/scudcloud/archive/v1.0.33.tar.gz
tar -xvf v1.0.33.tar.gz
cd scudcloud-1.0.33
SOURCE="scudcloud-1.0"
INSTALL="/opt/scudcloud"
sudo mkdir -p $INSTALL/lib
sudo mkdir -p $INSTALL/resources
sudo cp $SOURCE/lib/*.py $INSTALL/lib
sudo cp $SOURCE/resources/* $INSTALL/resources
sudo cp $SOURCE/scudcloud $INSTALL
sudo cp $SOURCE/LICENSE $INSTALL
sudo cp $SOURCE/scudcloud.desktop /usr/share/applications
sudo cp $SOURCE/systray/hicolor/* /usr/share/icons/hicolor/scalable/apps
sudo cp $SOURCE/systray/mono-dark/* /usr/share/icons/mono-dark/scalable/apps
sudo cp $SOURCE/systray/mono-light/* /usr/share/icons/mono-light/scalable/apps
sudo ln -sf $INSTALL/scudcloud /usr/bin/scudcloud
```

# Troubleshooting

## 1. Default domain

You can change the default domain editing or just deleting `~/.config/scudcloud/scudcloud.cfg`.

## 2. Where is the package for my distro?

If not listed above, you're welcome [to contribute](/CONTRIBUTING.md).

# Screenshots

![Some screenshots](/screenshot.png?raw=true)

# License

ScudCloud is is released under the [MIT License](/LICENSE).