Skip to content
/ s4 Public

s4 is an open source slack status management system.

License

Notifications You must be signed in to change notification settings

dtgrid/s4

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

S4

MIT License

Description

A simple bash package for changing slack status automatically designed for Mac users.
This package monitors your Mac's state and automatically switches slack status depends on WiFi-NAME.

S4 is an acronym for Slack Status Supervision System and has nothing to do with AWS.

Requirements

This package only requires Homebrew.
If you haven't installed HomeBrew yet, paste the command below to install Homebrew.

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

If any error occurs, please refer HomeBrew official and install it manually.

Installation

  1. git clone [email protected]:dgrid/s4.git or download this repository.

  2. If you don't have your slack api app yet, create slack apps on your Slack account.

  3. Open your slack app's page and click the app you just made.

  4. Click the OAuth and Permissions button on menu and scroll the page until Scopes panel.

  1. Choose Access user's profile and workspace profile fields and Modify user's profile. Then save changes.

  2. Click "Copy OAuth Access Token" button on the top of current page.

  1. Edit config file of this package(s4/config) and paste required informations.
TOKEN="YOUR ACCESS TOKEN"
AT_OFFICE_WIFI="YOUR OFFICES WIFI NAME"
AT_OFFICE_WIFI_2="ANOTHER OFFICES WIFI NAME"
AT_HOME_WIFI="YOUR HOMES WIFI NAME"
  1. Enter this command to load all settings. Finished!
./setup.sh

Advanced Usage

This package has 3 states depends on connected WiFi-NAME and Mac's states.

STATUS AT OFFICE AT HOME SLEEP
Mac's state Active Active sleep
WiFi-NAME AT_OFFICE_WIFI or AT_OFFICE_WIFI_2 AT_HOME_WIFI whatever
default text at office at home not working
default emoji 🏫 🏡 💤

You can modify each status description and emoji by editting config file.

AT_OFFICE_STATUS_TEXT="at office"
AT_OFFICE_STATUS_EMOJI=":school:"

AT_HOME_STATUS_TEXT="working remotely"
AT_HOME_STATUS_EMOJI=":house_with_garden:"

SLEEP_STATUS_TEXT="at home"
SLEEP_STATUS_EMOJI=":zzz:"

SLEEP_SECONDS=30

Lisence

MIT License

Contact

Author : Kei Wakabayashi
Company : DataGrid Co., Ltd.

About

s4 is an open source slack status management system.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages