renamed twicord to dir

Author: pyorot

design.md

@@ -3,7 +3,7 @@ A scrappy first-draft of how this program (v2) works.
 
 ## Files
 * **main/fetch.go** – Twitch API routines to `auth()` and `fetch()` data
-* **main/main.go** – core init and worker routines + twicord init
+* **main/main.go** – core init and worker routines + dir init
 * **main/msg.go** – Discord message channel init, worker, API methods
 * **main/role.go** – Discord role init, execution task, API methods
 * **main/stream.go** – streams struct with conversion methods + filter
@@ -20,7 +20,7 @@ This struct (defined in streams.go) and its conversions are the core data flow i
 
 **Data transitions r.e. messages:**
 * **user, start, thumbnail**: these 3 properties are set from incoming data in `newStreamFromTwitch()`, and never modified. The state stream copies the first snapshot during an add, then isn't touched, and gets encoded to + decoded from Discord messages.
-* **filter**: this is calculated from incoming data by checking twicord and running `filter()` on the title, but otherwise behaves as user/start/thumbnail. This means once the first snapshot enters internal state after an add, it will never change. However, filtered/unfiltered channels see different streams of snapshots (based on checking the filter), so messages representing the same stream may still differ between the two.
+* **filter**: this is calculated from incoming data by checking dir and running `filter()` on the title, but otherwise behaves as user/start/thumbnail. This means once the first snapshot enters internal state after an add, it will never change. However, filtered/unfiltered channels see different streams of snapshots (based on checking the filter), so messages representing the same stream may still differ between the two.
 * **title**: this is set in an incoming snapshot or persisted message from the relevant read data, then every command other than remove updates it in internal state to match the latest snapshot.
 * **length**: this is not set in an incoming snapshot, read if it exists from a persisted message, and otherwise *only* calculated (from the state stream's start) and set during a remove.
 
@@ -91,7 +91,7 @@ Any changes to or recovery of the bot are done by restarting it, at any time. It
 `msgAgent.init()` looks at the last 50 messages in its Discord channel and takes ownership of any representing active streams, reading info about a stream from its message into the state.
 
 **role**:  
-`roleInit()` creates a one-off inverted twicord, then goes through the entire user-list of the server to find matches. The initial state is then that, with unrecognised role-holders being flagged for removal by inserting their Discord ID instead of their twitch handle into the state (this is both unique and will never match a Twitch username).
+`roleInit()` creates a one-off inverted dir, then goes through the entire user-list of the server to find matches. The initial state is then that, with unrecognised role-holders being flagged for removal by inserting their Discord ID instead of their twitch handle into the state (this is both unique and will never match a Twitch username).
 
 ## Comparing Msg and Role
 msg is the more suitable design, since it gives a sequential consistency guarantee to the state, and Discord API rate limits are scoped to the channel/role, i.e. exactly the requests managed by a single instance of msg/role, so they can be paced precisely in series.

main/main.go

@@ -14,21 +14,21 @@ import (
 	"github.com/nicklaw5/helix"
 )
 
-// main.go:   main program init and loop + twicord init
+// main.go:   main program init and loop + dir init
 // fetch.go:  twitch auth + streams data poll
 // msg.go:    managing a streams channel (posting to Discord)
 // role.go:   managing a streams role (posting to Discord)
 // stream.go: stream struct and conversion/filter methods
 // utils.go:  macros for if, errors, env vars
 
-var err error                         // placeholder error
-var twitch *helix.Client              // Twitch client
-var discord *discordgo.Session        // Discord client
-var filterRequired bool               // will generate filtered map of incoming streams
-var filterTags []string               // Twitch tags to look for
-var filterKeywords []string           // title keywords to look for
-var twicord = make(map[string]string) // map: twitch user -> Discord user ID
-// twicord is used to look up Discord users to assign roles to + maybe to filter a msg channel
+var err error                     // placeholder error
+var twitch *helix.Client          // Twitch client
+var discord *discordgo.Session    // Discord client
+var filterRequired bool           // will generate filtered map of incoming streams
+var filterTags []string           // Twitch tags to look for
+var filterKeywords []string       // title keywords to look for
+var dir = make(map[string]string) // map: twitch user -> Discord user ID
+// dir is used to look up Discord users to assign roles to + maybe to filter a msg channel
 
 // runs on program start
 func init() {
@@ -64,11 +64,11 @@ func init() {
 		filterKeywords = strings.Split(rawKeywords, ",")
 		log.Insta <- fmt.Sprintf(". | filter keywords [%d]: %s", len(filterKeywords), filterKeywords)
 	}
-	if twicordChannel := getEnvOrEmpty("TWICORD_CHANNEL"); twicordChannel != "" {
-		twicordInit(twicordChannel) // do this sync cos role init depends on it
+	if dirChannel := getEnvOrEmpty("DIR_CHANNEL"); dirChannel != "" {
+		dirInit(dirChannel) // do this sync cos role init depends on it
 	}
 
-	// msg icons init (2,1,0 = known on twicord, not known but passed filter, other rsp.)
+	// msg icons init (2,1,0 = known on dir, not known but passed filter, other rsp.)
 	if url := getEnvOrEmpty("MSG_ICON"); url != "" {
 		iconURL[0], iconURL[1], iconURL[2] = url, url, url
 		if url2 := getEnvOrEmpty("MSG_ICON_PASS"); url2 != "" {
@@ -95,10 +95,10 @@ func init() {
 		}
 	}
 
-	// role init (requires twicord)
+	// role init (requires dir)
 	var awaitRoles = make([]chan (bool), 0)           // a list to collect async tasks, to be awaited later. there's only 1 but i might add more later
 	if roleID = getEnvOrEmpty("ROLE"); roleID != "" { // if ROLE is missing, user probs doesn't want a role
-		roleServerID = getEnvOrExit("ROLE_SERVER")  // if ROLE is there but ROLE_SERVER missing, user probs forgot the server
+		roleServerID = getEnvOrExit("SERVER")       // if ROLE is there but SERVER missing, user probs forgot the server
 		awaitRoles = append(awaitRoles, roleInit()) // run async task (returns channel)
 	}
 
@@ -146,23 +146,23 @@ func main() {
 	}
 }
 
-// blocking http req to read twicord data from a Discord chan
+// blocking http req to read dir data from a Discord chan
 // that contains a bunch of posts in the format (where dui = Discord userID, tun = Twitch username):
-// "twicord<comment>\n<dui1>\s<tun1>\n<dui2>\s<tun2>\n..."
-func twicordInit(channel string) {
+// "dir<comment>\n<dui1>\s<tun1>\n<dui2>\s<tun2>\n..."
+func dirInit(channel string) {
 	history, err := discord.ChannelMessages(channel, 50, "", "", "") // get last 50 msgs (max poss is 50)
 	exitIfError(err)
 	for _, msg := range history {
-		if len(msg.Content) >= 8 && msg.Content[:7] == "twicord" { // pick msgs starting with "twicord"
+		if len(msg.Content) >= 4 && msg.Content[:3] == "dir" { // pick msgs starting with "dir"
 			scanner := bufio.NewScanner(strings.NewReader(msg.Content)) // line-by-line iterator
-			scanner.Scan()                                              // skip 1st line ("twicord<comment>\n")
+			scanner.Scan()                                              // skip 1st line ("dir<comment>\n")
 			for scanner.Scan() {
 				line := strings.TrimSpace(scanner.Text())
 				splitIndex := strings.IndexByte(line, ' ')
-				twicord[strings.ToLower(line[splitIndex+1:])] = line[:splitIndex] // dict is rhs → lhs
+				dir[strings.ToLower(line[splitIndex+1:])] = line[:splitIndex] // dict is rhs → lhs
 			}
 			exitIfError(scanner.Err())
 		}
 	}
-	log.Insta <- fmt.Sprintf(". | twicord loaded (from %s) [%d]", channel, len(twicord))
+	log.Insta <- fmt.Sprintf(". | dir loaded (from %s) [%d]", channel, len(dir))
 }

main/role.go

@@ -18,11 +18,11 @@ func roleInit() chan (bool) {
 	res := make(chan (bool), 1) // returned immediately; posted to when done
 	go func() {                 // anonymous function in new thread; posts to res when done
 		// create inverse dict to identify for each discord user if eir stream is still up
-		inverseTwicord := make(map[string]string, len(twicord))
-		for k, v := range twicord {
-			inverseTwicord[v] = k
+		inverseDir := make(map[string]string, len(dir))
+		for k, v := range dir {
+			inverseDir[v] = k
 		}
-		// find every discord member with the role and register using twicord
+		// find every discord member with the role and register using dir
 		next := ""     // ID of next user, used to chain sync calls (endpoint has 1000-result limit)
 		userCount := 0 // will track total users detected
 		for {
@@ -36,8 +36,8 @@ func roleInit() chan (bool) {
 				for _, user := range users {
 					for _, role := range user.Roles {
 						if role == roleID { // if managed role is in user's roles
-							twitchHandle, isInTwicord := inverseTwicord[user.User.ID]
-							if isInTwicord {
+							twitchHandle, isInDir := inverseDir[user.User.ID]
+							if isInDir {
 								roles[twitchHandle] = user.User.ID
 							} else { // if unknown user, trigger role-removal by registering under unique non-existent handle
 								roles[user.User.ID] = user.User.ID
@@ -68,7 +68,7 @@ func role(new map[string]*stream) {
 	}
 	for user := range new { // iterate thru new to pick additions
 		_, isInOld := roles[user]
-		userID, isReg := twicord[user] // look-up Twitch username in twicord (skip user if not found)
+		userID, isReg := dir[user] // look-up Twitch username in dir (skip user if not found)
 		if !isInOld && isReg {
 			log.Insta <- "r | + " + user
 			addsCh[user] = roleAdd(userID) // async call; registers await chan
@@ -83,7 +83,7 @@ func role(new map[string]*stream) {
 	}
 	for user, ch := range addsCh {
 		if <-ch {
-			roles[user] = twicord[user]
+			roles[user] = dir[user]
 		}
 	}
 

main/stream.go

@@ -30,7 +30,7 @@ func newStreamFromTwitch(r *helix.Stream) *stream {
 		thumbnail: r.ThumbnailURL[:strings.LastIndexByte(r.ThumbnailURL, '-')+1] + "440x248.jpg",
 		// length is not set until stream goes down
 	}
-	if _, isReg := twicord[strings.ToLower(s.user)]; isReg {
+	if _, isReg := dir[strings.ToLower(s.user)]; isReg {
 		s.filter = 2
 	} else if filterStream(r) {
 		s.filter = 1

readme.md

@@ -14,17 +14,17 @@ New streams are posted with a green embed. When a stream goes offline, its post
 **Roles**  
 A user simply has the role while live. Display the role in the members sidebar, and each user's stream will be easily clickable provided ey is online on Discord, has Twitch correctly linked, and has streamer mode enabled.
 
-*Since Discord doesn't reveal a user's associated Twitch account to bots, the roles functionality requires manually-posted lists of Discord user IDs and associated Twitch usernames, marked **twicord**, in a separate Discord channel. The bot will parse the 50 latest posts in a channel that have a syntax as follows:*
+*Since Discord doesn't reveal a user's associated Twitch account to bots, the roles functionality requires manually-posted lists of Discord user IDs and associated Twitch usernames, marked **dir**, in a separate Discord channel. The bot will parse the 50 latest posts in a channel that have a syntax as follows:*
 
 ```
-twicord <optional-comment-here-with-no-newlines>
+dir <optional-comment-here-with-no-newlines>
 <discord-user-ID-1> <twitch-user-handle1>
 <discord-user-ID-2> <twitch-user-handle2>
 ...
 ```
 
 **Filtering**  
-The twicord tables inherently filter which Discord users get assigned a role. A message channel can also be filtered. This means it accepts only streams whose users are in twicord or whose tags/titles match a list of tags/keywords. E.g.
+The dir tables inherently filter which Discord users get assigned a role. A message channel can also be filtered. This means it accepts only streams whose users are in dir or whose tags/titles match a list of tags/keywords. E.g.
 ```
 FILTER_TAGS=7cefbf30-4c3e-4aa7-99cd-70aabb662f27
 FILTER_KEYWORDS=speedrun,any%,all dungeons,glitchless,race,mss,pausa,practice
@@ -64,11 +64,11 @@ The settings are:
 * **GAME** – ID of the game to track (requires an API request to find out).
 * **MSG_CHANNELS** – list of Discord channel IDs separated by commas, no spaces. Prepend + for filtered channels and * for unfiltered. E.g. `+693315004228698142,*296066428694429697`.
 * **MSG_ICON** – custom icon for message embeds.
-* **MSG_ICON_PASS** – icon for streams that pass the filter (tag/keyword/twicord); requires and overrides `MSG_ICON`.
-* **MSG_ICON_KNOWN** – icon for users that are in twicord; requires and overrides `MSG_ICON_PASS`.
+* **MSG_ICON_PASS** – icon for streams that pass the filter (tag/keyword/dir); requires and overrides `MSG_ICON`.
+* **MSG_ICON_KNOWN** – icon for users that are in dir; requires and overrides `MSG_ICON_PASS`.
 * **ROLE** – ID of Discord streams role.
 * **ROLE_SERVER** – ID of Discord server containing streams role.
-* **TWICORD_CHANNEL** – ID of Discord channel for loading twicord directory.
+* **TWICORD_CHANNEL** – ID of Discord channel for loading dir directory.
 * **FILTER_TAGS** – list of Twitch tags to filter streams for (in UUID format), separated by commas, no spaces.
 * **FILTER_KEYWORDS** – list of substrings to filter stream titles for, separated by commas, no spaces.