Colorred output, split utils, gofmt, and README.md improvements

Author: onescriptkid

README.md

@@ -1,28 +1,32 @@
-![Tons of essence](./assets/blueessence.png)
 
-# disenchant
-Disenchant all **owned** *champions* and *champion shards* with 1 click
 
-![Disenchant Champion shards](./assets/disenchant.png)
+# disenchant ![go19](https://img.shields.io/badge/go-1.19-blue) ![LoL client](https://img.shields.io/badge/LeagueClient-12.16.462.9630-gold) ![LoL Game](https://img.shields.io/badge/LeagueGame-12.16.4624391-purple)
+Disenchant all **owned** *champions* and *champion shards* with 1 click
 
+<d> | <d>
+:-------------------------:|:-------------------------:
+![Disenchant Champion shards](./assets/disenchant.png) | ![Tons of essence](./assets/blueessence.png)
 
 ## 🚀 Quickstart
 
 - **Open** the LoL client
-- **Download** [disenchant.exe](https://github.com/onescriptkid/disenchant/releases/download/v0.0.3/disenchant.exe)
+- **Download** [disenchant.exe](https://github.com/onescriptkid/disenchant/releases/download/v0.0.4/disenchant.exe)
 - **Doubleclick** the exectuable - `disenchant.exe`
 
 ## 😢 Notable shortfalls
 
-- #️⃣ only works with windows
-- ~~🐧not compatible with linux~~
-- ~~🍎 not compatiable with OSX~~
+- #️⃣ only built for windows
+- ~~🐧not yet compatible on linux~~
+- ~~🍎 not yet compatiable on OSX~~
 
 ## Riot League Client API
 
-`disenchant.go` queries the riot league client [api](https://riot-api-libraries.readthedocs.io/en/latest/lcu.html) to gather loot and select champion shards to convert to blue essence
+`disenchant.go` queries the riot league client [api](https://riot-api-libraries.readthedocs.io/en/latest/lcu.html) for loot and selects champion shards to convert to blue essence
 
 ### Get Request - list of champion shards
+
+> Replace `<password>` with the *4th* value from the `lockfile - "C:\\Riot Games\\League of Legends\\lockfile"` : `LeagueClient:13340:56695:yQ*****Ekw:https`
+
 ```bash
 curl --insecure --basic --user riot:<password> -H "Accept: application/json" -v https://localhost:65023/lo
 l-loot/v1/player-loot

disenchant.go

@@ -1,34 +1,37 @@
 package main
 
 import (
-	"io/ioutil"
-	"os"
-	"fmt"
+	"bytes"
+	"crypto/tls"
+	"encoding/base64"
+	"encoding/json"
 	"errors"
+	"fmt"
 	"github.com/onescriptkid/disenchant/utils"
+	"io/ioutil"
+	"log"
+	"net/http"
+	"os"
 	"path/filepath"
 	"strings"
-	"encoding/base64"
-	"net/http"
-	"time"
-	"crypto/tls"
-	"encoding/json"
 	"sync"
-	"bytes"
-	"log"
-	// "io"
+	"time"
 )
 
 type RiotLoot struct {
 	DisenchantLootName string `json:"disenchantLootName"`
-	ItemStatus string `json:"itemStatus"`
-	ItemDesc string `json:"itemDesc"`
-	LootName string `json:"lootName"`
-	Count int `json:"count"`
-	Type string `json:"type"`
+	ItemStatus         string `json:"itemStatus"`
+	ItemDesc           string `json:"itemDesc"`
+	LootName           string `json:"lootName"`
+	Count              int    `json:"count"`
+	Type               string `json:"type"`
 }
 
 func main() {
+	// Fix colorred terminal output specific to windows cmd prompt
+	utils.FixWindowsColors()
+
+	// Show Title and set trap to always prompt user before quiting. Prevents app from immediately closing on finish.
 	utils.Title("Disenchanting blue essence ...")
 	defer utils.OnFinish()
 
@@ -37,7 +40,7 @@ func main() {
 	if err != nil {
 		utils.ErrorFatal(err)
 	}
-	
+
 	// Build http client to interact with Riot Lol client api
 	client, err := BuildHttpClient(port, token)
 	if err != nil {
@@ -53,7 +56,7 @@ func main() {
 	AreYouSure()
 
 	// Disenchant champion shards
-	err = DisenchantChampionShards(client, port, token, champions) 
+	err = DisenchantChampionShards(client, port, token, champions)
 	if err != nil {
 		utils.ErrorFatal(err)
 	}
@@ -62,9 +65,9 @@ func main() {
 }
 
 // Get Port and Token from LoL Riot lockfile
-func getPortAndToken() ( port string, token string, err error ) {
+func getPortAndToken() (port string, token string, err error) {
 	utils.Header("Searching for lockfile ...")
-	
+
 	// Retrieve standard set of lockfile paths
 	paths, pathErr := utils.GetLockFilePaths()
 	if err != nil {
@@ -86,14 +89,14 @@ func getPortAndToken() ( port string, token string, err error ) {
 
 		// If lockfile found, exit loop. Otherwise, keep searching.
 		lockfilePath = abs
-		_, err = os.Stat(lockfilePath);
+		_, err = os.Stat(lockfilePath)
 		if err == nil {
 			msg := fmt.Sprintf("  Found %s. Parsing lockfile ...", lockfilePath)
 			foundLockfile = true
 			fmt.Println(msg)
 			break
 		} else if errors.Is(err, os.ErrNotExist) {
-			msg := fmt.Sprintf("  Missing %s. Seaching other locations for lockfile", lockfilePath)
+			msg := fmt.Sprintf("  Missing %s. Seaching other locations for lockfile ...", lockfilePath)
 			utils.Warn(msg)
 		} else {
 			return
@@ -133,18 +136,18 @@ func getPortAndToken() ( port string, token string, err error ) {
 }
 
 // Build http client to interact with Riot Lol client api
-func BuildHttpClient(port string, token string)(client http.Client, err error) {
+func BuildHttpClient(port string, token string) (client http.Client, err error) {
 	utils.Header("Building http client ...")
 
 	// Instantiate http client
-	tr := &http.Transport{ TLSClientConfig: &tls.Config{InsecureSkipVerify: true} }
+	tr := &http.Transport{TLSClientConfig: &tls.Config{InsecureSkipVerify: true}}
 	client = http.Client{Timeout: time.Duration(10) * time.Second, Transport: tr}
 
 	return
 }
 
 // List all champion shards convertable to blue essence
-func ListChampionShards(client http.Client, port string, token string)(champions []RiotLoot, err error) {
+func ListChampionShards(client http.Client, port string, token string) (champions []RiotLoot, err error) {
 	utils.Header("Searching for champions to disenchant ...")
 	host := fmt.Sprintf("https://127.0.0.1:%s", port)
 	auth := fmt.Sprintf("Basic %s", token)
@@ -187,12 +190,15 @@ func ListChampionShards(client http.Client, port string, token string)(champions
 	json.NewDecoder(res.Body).Decode(&riotLoot)
 
 	// Iterate over all RiotLoot and only select champion shards that are owned for disenchanting
+	total := 0
 	for _, loot := range riotLoot {
 		if loot.DisenchantLootName == "CURRENCY_champion" && loot.ItemStatus == "OWNED" {
-			fmt.Printf("  Found %4v %s \n", loot.Count, loot.ItemDesc,)
+			fmt.Printf("  Found %4v %s \n", loot.Count, loot.ItemDesc)
 			champions = append(champions, loot)
+			total += loot.Count
 		}
 	}
+	fmt.Printf("Total %v champions to disenchant ... \n", total)
 
 	return
 }
@@ -202,20 +208,20 @@ func AreYouSure() {
 	var input string
 
 	for input != "y" && input != "Y" {
-		utils.Title("Are you sure? Press [y] to continue or [n] to quit...\n")
-		fmt.Scan(&input)
+		utils.Title("Are you sure? Press [y] to continue or [n] to quit\n")
+		fmt.Scanln(&input)
 
 		// Quit if n or N
-		if(input == "n" || input == "N") {
+		if input == "n" || input == "N" {
 			no := errors.New("Quitting ...")
 			utils.ErrorFatal(no)
 		}
 	}
 
 }
 
-// Disenchant all champion shards found on the account 
-func DisenchantChampionShards(client http.Client, port string, token string, champions []RiotLoot)( err error) {
+// Disenchant all champion shards found on the account
+func DisenchantChampionShards(client http.Client, port string, token string, champions []RiotLoot) (err error) {
 	utils.Header("Disenchanting champions ...")
 	host := fmt.Sprintf("https://127.0.0.1:%s", port)
 	auth := fmt.Sprintf("Basic %s", token)
@@ -260,23 +266,22 @@ func DisenchantChampionShards(client http.Client, port string, token string, cha
 				return
 			}
 
-			// Print JSON response from disenchant post request
-			// Uncomment to print result of disenchant post request json 
+			// Uncomment to print JSON response for disenchant POST request
 			// b, err := io.ReadAll(res.Body)
 			// if err != nil {
 			// 	log.Fatalln(err)
 			// }
 			// fmt.Println(string(b))
 			// fmt.Printf("  Url %s\n", url)
 			// fmt.Printf("  Auth %s\n", auth)
+
 			wg.Done()
 		}(client, port, token, champion)
 	}
-	
+
 	// Wait for every thread to finish
 	wg.Wait()
 
 	return
 
 }
-

go.mod

@@ -7,5 +7,5 @@ require (
 	github.com/fatih/color v1.13.0 // indirect
 	github.com/mattn/go-colorable v0.1.9 // indirect
 	github.com/mattn/go-isatty v0.0.14 // indirect
-	golang.org/x/sys v0.0.0-20220818161305-2296e01440c6 // indirect
+	golang.org/x/sys v0.0.0-20220825204002-c680a09ffe64 // indirect
 )

go.sum

@@ -13,3 +13,5 @@ golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK
 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220818161305-2296e01440c6 h1:Sx/u41w+OwrInGdEckYmEuU5gHoGSL4QbDz3S9s6j4U=
 golang.org/x/sys v0.0.0-20220818161305-2296e01440c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220825204002-c680a09ffe64 h1:UiNENfZ8gDvpiWw7IpOMQ27spWmThO1RwwdQVbJahJM=
+golang.org/x/sys v0.0.0-20220825204002-c680a09ffe64/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

utils/helpers.go

@@ -0,0 +1,37 @@
+package utils
+
+import (
+	"errors"
+	"fmt"
+	"runtime"
+)
+
+// Always catch on finish
+func OnFinish() {
+	fmt.Print("Press [enter] to continue ...")
+	fmt.Scanln()
+}
+
+// Get LockFile Locations
+func GetLockFilePaths() (paths []string, err error) {
+	osname := runtime.GOOS
+	switch osname {
+	case "windows":
+		samePath := "./lockfile"
+		lolPath := "C:\\Riot Games\\League of Legends\\lockfile"
+		pbePath := "C:\\Riot Games\\League of Legends (PBE)\\lockfile"
+		paths = []string{samePath, lolPath, pbePath}
+		return
+	case "darwin":
+		err = errors.New("Unavailable on OSX")
+		return
+	case "linux":
+		err = errors.New("Unavailable on linux")
+		return
+	default:
+		fmt.Printf("%s.\n", osname)
+		msg := fmt.Sprintf("Unavailabe on %s", osname)
+		err = errors.New(msg)
+		return
+	}
+}

utils/text.go

@@ -0,0 +1,57 @@
+package utils
+
+import (
+	"fmt"
+	"github.com/fatih/color"
+	"golang.org/x/sys/windows"
+	"os"
+	"runtime"
+)
+
+func FixWindowsColors() {
+	if runtime.GOOS == "windows" {
+		stdout := windows.Handle(os.Stdout.Fd())
+		var originalMode uint32
+
+		windows.GetConsoleMode(stdout, &originalMode)
+		windows.SetConsoleMode(stdout, originalMode|windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING)
+	}
+}
+
+// Print error in red and then exit with exit status 1
+// Escape colors work differntly in Windows. Swapping to tabs/spaces.
+func ErrorFatal(err error) {
+	red := color.New(color.FgRed).SprintFunc()
+	fmt.Println(red(err))
+	os.Exit(1)
+}
+
+// Print log in yellow as warning
+func Warn(msg string) {
+	yellow := color.New(color.FgYellow).SprintFunc()
+	fmt.Println(yellow(msg))
+}
+
+// Print success in green
+func Green(msg string) {
+	green := color.New(color.Bold, color.FgGreen).SprintFunc()
+	fmt.Println(green(msg))
+}
+
+// Print header in bold font
+func Header(msg string) {
+	bold := color.New(color.Bold).SprintFunc()
+	fmt.Println(bold(msg))
+}
+
+// Print Title in bold cyan font
+func Title(msg string) {
+	boldCyan := color.New(color.Bold, color.FgCyan).SprintFunc()
+	fmt.Println(boldCyan(msg))
+}
+
+// Print in in bold cyan font
+func BoldCyan(msg string) {
+	boldCyan := color.New(color.Bold, color.FgCyan).SprintFunc()
+	fmt.Println(boldCyan(msg))
+}