diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 42 |
1 files changed, 27 insertions, 15 deletions
@@ -44,7 +44,7 @@ In Development Dependencies ------------ - * WeeChat 1.3+ http://weechat.org/ + * WeeChat 1.3+ http://weechat.org/ * websocket-client https://pypi.python.org/pypi/websocket-client/ Setup @@ -86,11 +86,13 @@ cp wee_slack.py ~/.weechat/python/autoload weechat ``` +**NOTE:** If weechat is already running, the script can be loaded using ``/python load python/autoload/wee_slack.py`` + ####4. Add your Slack API key(s) ``` /set plugins.var.python.slack_extension.slack_api_token [YOUR_SLACK_TOKEN] ``` -^^ (find this at https://api.slack.com/web) +^^ (find this at https://api.slack.com/web behind the "Generate test tokens" button) If you don't want to store your API token in plaintext you can use the secure features of weechat: @@ -101,7 +103,7 @@ If you don't want to store your API token in plaintext you can use the secure fe ``` ##### Optional: If you would like to connect to multiple groups, use the above command with multiple tokens separated by commas. (NO SPACES) - + ``` /set plugins.var.python.slack_extension.slack_api_token [token1],[token2],[token3] ``` @@ -165,16 +167,6 @@ Add a reaction to the nth last message. The number can be omitted and defaults t 3+:smile: ``` -Turn off colorized nicks: -``` -/set plugins.var.python.slack_extension.colorize_nicks 0 -``` - -Set channel prefix to something other than my-slack-subdomain.slack.com (e.g. when using buffers.pl): -``` -/set plugins.var.python.slack_extension.server_alias.my-slack-subdomain "mysub" -``` - Set all read markers to a specific time: ``` /slack setallreadmarkers (time in epoch) @@ -191,7 +183,27 @@ Debug mode: ``` Optional settings ----------------- +----------------- + +Turn off colorized nicks: +``` +/set plugins.var.python.slack_extension.colorize_nicks 0 +``` + +Turn on colorized messages (messages match nick color): +``` +/set plugins.var.python.slack_extension.colorize_nicks 1 +``` + +Set channel prefix to something other than my-slack-subdomain.slack.com (e.g. when using buffers.pl): +``` +/set plugins.var.python.slack_extension.server_alias.my-slack-subdomain "mysub" +``` + +Show who added each reaction. Makes reactions appear like `[:smile:(@nick1,@nick2)]` instead of `[:smile:2]`. +``` +/set plugins.var.python.slack_extension.show_reaction_nicks on +``` Show typing notification in main bar (slack_typing_notice): ``` @@ -211,4 +223,4 @@ wee-slack is provided without any warranty whatsoever, but you are welcome to as - + |