Merge pull request #15 from jake-abed/v0.3.0-fixes

V0.3.0 fixes

Author: jake-abed

README.md

@@ -1,4 +1,5 @@
 # Lore
+
 A CLI tool for game masters running D&D, Pathfinder, and other tabletop game
 campaigns. All written in Go. While I still largely run a pen & paper campaign,
 I always keep a laptop up and running for looking up info and keeping notes.
@@ -10,14 +11,17 @@ Currently a work in progress, but still functional!
 ## Installing Lore
 
 Prerequisites:
+
 - Go
 - SQLite3
 
-Install the Go toolchain [via the docs](https://go.dev/doc/install) or [via webi](https://webinstall.dev/golang/)!
+Install the Go toolchain [via the docs](https://go.dev/doc/install) or
+[via webi](https://webinstall.dev/golang/)!
 
 Install SQLite3 via your necessary method!
 
 For example:
+
 ```bash
 # Ubuntu
 sudo apt update && sudo apt upgrade && sudo apt install sqlite3
@@ -30,51 +34,73 @@ brew install sqlite3
 ```
 
 Now simply install Lore via the Go toolchain:
+
 ```bash
 go install github.com/jake-abed/lore
 ```
 
 ## Commands
 
 ### **help**
+
 Lists all available commands
 
 ### **dice**
-- **-a <dice-expression>** | Rolls a dice expression and returns the result summed up.
-- **-i <dice-expression>** | Rolls a dice expression, printing each roll individually, then summing it up.
+
+- **-a <dice-expression>** | Rolls a dice expression and returns the result
+  summed up.
+- **-i <dice-expression>** | Rolls a dice expression, printing each roll
+  individually, then summing it up.
+
 #### Examples of Dice Expressions
-> d20, 1d6, 2d12+1, 1d4-1, 3d6+8, 5d20+12, 80d100-50, etc. 
+
+> d20, 1d6, 2d12+1, 1d4-1, 3d6+8, 5d20+12, 80d100-50, etc.
 
 ### **monsters**
-- **-i <monster name or id>**    | Get basic information about a monster from the D&D 5e API.
-- **-f <monster-1> <monster-2>** | Simulate a turn-based fight between two monsters.
-- - Slightly skewed as it does not factor movement or flying into the battles, so extremely agile or flying monsters will have less of an edge than they normal would.
+
+- **-i <monster name or id>** | Get basic information about a monster from the
+  D&D 5e API.
+- **-f <monster-1> <monster-2>** | Simulate a turn-based fight between two
+  monsters.
+- - Slightly skewed as it does not factor movement or flying into the battles,
+    so extremely agile or flying monsters will have less of an edge than they
+    normal would.
+- **-va** | View all monsters from the D&D API. Great with grep!
 
 ### **npcs**
+
 View, search, edit, and create custom NPCs for your campaign.
 
-- **-a**        | Add new NPC via form!
+- **-a** | Add new NPC via form!
 - **-v <name>** | View an NPC with the provided name (exact match).
+- **-d <id>** | Delete an NPC by ID.
 - **-s <name>** | Lists all NPCs that partially match the provided name.
 - **-e <name>** | Edit an NPC with the provided name (exact match).
 
 ### **places**
+
 View, search, edit, and create custom places for your campaign.
-- **<place-flag> -a**         | Add a new place via form!
-- **<place-flag> -d** <id>    | Delete a place by ID represented as an integer.
-- **<place-flag > -v <name>** | View a place with the provided name (exact match).
-- **<place-flag> -s <name>**  | Lists all places that partially match the provided name.
-- **<place-flag> -e <name>**  | Edit a place with the provided name (exact match).
+
+- **<place-flag> -a** | Add a new place via form!
+- **<place-flag> -d** <id> | Delete a place by ID represented as an integer.
+- **<place-flag > -v <name>** | View a place with the provided name (exact
+  match).
+- **<place-flag> -s <name>** | Lists all places that partially match the
+  provided name.
+- **<place-flag> -e <name>** | Edit a place with the provided name (exact
+  match).
 
 #### Uses 'place flags' to mark which place type you are operating on.
-- --world       | Overaching world for a campaign.
-- --area        | Areas or regions of a world.
-- --location    | Locations contained within areas.
+
+- --world | Overaching world for a campaign.
+- --area | Areas or regions of a world.
+- --location | Locations contained within areas.
 - --sublocation | Not implemented! Not sure if necessary or overkill?
 
 ## Roadmap
 
 While not set in stone, hitting a true v1.0.0 will include:
+
 - [x] ~~Dice Rolls~~
 - - ~~`lore dice <dice-arg>` allowing for dynamic dice rolls!~~
 - - - ~~For example `lore dice 2d6+1` rolls two six-sided die and adds one!~~
@@ -89,30 +115,38 @@ While not set in stone, hitting a true v1.0.0 will include:
 - [ ] Encounters
 - - Write encounters and then serve them up randomly to the GM.
 
-I'm also debating adding a custom monsters section or replacing the API with custom monsters. The catch here is that monsters are... complex and require significantly more work to customize. They also require knowledge of the game system being used. Lore is supposed to be game system agnostic for custom info. So, feedback would be nice here.
+I'm also debating adding a custom monsters section or replacing the API with
+custom monsters. The catch here is that monsters are... complex and require
+significantly more work to customize. They also require knowledge of the game
+system being used. Lore is supposed to be game system agnostic for custom info.
+So, feedback would be nice here.
 
 ### NB on Compatibility
 
-Up until v1.0.0 Lore should be considered unstable. The shape of the DB is a work in progress and I cannot promise compatibility.
+Up until v1.0.0 Lore should be considered unstable. The shape of the DB is a
+work in progress and I cannot promise compatibility.
 
-Starting at v1.0.0, the DB schema will be stable and non-breaking changes only will happen.
+Starting at v1.0.0, the DB schema will be stable and non-breaking changes only
+will happen.
 
 ## Contributing
 
 Want to contribute to Lore at all?
 
 ### Clone the repo:
+
 ```bash
 git clone https://github.com/jake-abed/lore
 cd lore
 ```
 
 ### Build it:
+
 ```bash
 go build
 ```
 
 ### Submit a pull request!
 
-If you want to contribute anything at all, please fork the repository
-and open up a pull request to the 'main' branch.
+If you want to contribute anything at all, please fork the repository and open
+up a pull request to the 'main' branch.

commands/command.go

@@ -6,7 +6,6 @@ import (
 )
 
 type Command struct {
-	Flags       map[string]string
 	Name        string
 	Description string
 	Callback    func(*State) error
@@ -23,70 +22,32 @@ func BuildCommands() map[string]Command {
 		"help": {
 			Name:        "help",
 			Description: "Get information about all available commands.",
-			Flags:       nil,
 			Callback:    commandHelp,
 		},
 		"dice": {
 			Name:        "dice",
 			Description: "Roll dice in the following format: {qtyDice}d{Die}{+/-}{modifier}.",
-			Flags: map[string]string{
-				"-a":       "Rolls all the dice at once and returns the result.",
-				"-i":       "Rolls individual dice, presenting the result, then returning the total.",
-				"Examples": "d20, 1d6, 2d12+1, 1d4-1, 3d6+8, 5d20+12, 80d100-50, etc.",
-			},
-			Callback: commandDice,
+			Callback:    commandDice,
 		},
 		"monsters": {
 			Name:        "monsters",
 			Description: "Get info about monsters and simulate fights.",
-			Flags: map[string]string{
-				"-i":  "Looks up info about a particular monster by name or id slug.",
-				"-f":  "Simulate a fight between two monsters. Name or id slug work.",
-				"-va": "View all monsters on the D&D 5e OpenAPI.",
-			},
-			Callback: commandMonsters,
+			Callback:    commandMonsters,
 		},
 		"npcs": {
 			Name:        "npcs",
 			Description: "Add, search, edit, & view info about NPCs.",
-			Flags: map[string]string{
-				"-v": "Inspect an NPC and view their info.",
-				"-a": "Add an NPC to your local database for your campaign.",
-				"-e": "Edit an NPC's info by name. Case-insensitive.",
-				"-s": "Search your NPCs by name. Returns all possible matches.",
-				"-d": "Delete an NPC by name. Case-sensitive.",
-			},
-			Callback: commandNpcs,
+			Callback:    commandNpcs,
 		},
 		"places": {
 			Name:        "places",
 			Description: "Add, search, edit, & view worlds, areas, & locations.",
-			Flags: map[string]string{
-				"-a":            "Add a place.",
-				"-e":            "Edit a place.",
-				"-s":            "Search places by name. Returns all possible matches",
-				"-d":            "Delete a place by name. Case-sensitive.",
-				"-v":            "Inspect a place and it's information by name.",
-				"-va":           "View a short summary of all places by place flag.",
-				"--world":       "Specify an operation on a world.",
-				"--area":        "Specify an operation on an area.",
-				"--location":    "Specify an operation on a location.",
-				"--sublocation": "Specify an operation on a sublocation.",
-			},
-			Callback: commandPlaces,
+			Callback:    commandPlaces,
 		},
 		"quests": {
 			Name:        "quests",
 			Description: "Add, search, edit & view quests & quest steps.",
-			Flags: map[string]string{
-				"-a":  "Add a quest.",
-				"-e":  "Edit a quest by ID.",
-				"-v":  "View a quest by ID.",
-				"-d":  "Delete a quest by ID.",
-				"-s":  "Search a quest by name.",
-				"-va": "View all quests, returning most data. Great for grep & piping!",
-			},
-			Callback: commandQuests,
+			Callback:    commandQuests,
 		},
 	}
 }

commands/command_dice.go

@@ -12,7 +12,12 @@ func commandDice(s *State) error {
 	diceArgs := s.Args[1:]
 
 	if len(diceArgs) == 0 {
-		return fmt.Errorf("The dice command requires at least one argument!")
+		return fmt.Errorf("the dice command requires at least one argument")
+	}
+
+	if len(diceArgs) == 1 && diceArgs[0] == "help" {
+		diceHelp()
+		return nil
 	}
 
 	var flag string
@@ -27,7 +32,7 @@ func commandDice(s *State) error {
 	}
 
 	if !strings.Contains(diceExpression, "d") {
-		return fmt.Errorf("Invalid Dice Expression: %s", diceExpression)
+		return fmt.Errorf("nvalid Dice Expression: %s", diceExpression)
 	}
 
 	switch flag {
@@ -53,11 +58,26 @@ func commandDice(s *State) error {
 			msg = bold.Render(msg)
 			fmt.Println(msg, roll)
 		}
-		msg := fmt.Sprintf("Sum of all rolls & modifier: ")
+		msg := "Sum of all rolls & modifier: "
 		msg = bold.Render(msg)
 		fmt.Println(msg, sum+int(modifier))
 	default:
-		return fmt.Errorf("Unknown flag for dice subcommand!")
+		return fmt.Errorf("unknown flag for dice subcommand")
 	}
 	return nil
 }
+
+func diceHelp() {
+	intro := "Lore Dice Help\n"
+	introTip := "Dice subcommands information"
+	fmt.Println(header.Render(intro + introTip))
+	all := bold.Render("  *** dice -a <monster-1> <monster-2> | ")
+	allMessage := "Roll all the dice of an expression together returning the result."
+	fmt.Println(all + allMessage)
+	individual := bold.Render("  *** dice -i <dice-expression> | ")
+	individualMessage := "Roll each die of an expression one at a time."
+	fmt.Println(individual + individualMessage)
+	example := bold.Render("  *** Examples | ")
+	exampleMessage := "d20, 1d6, 2d12+1, 1d4-1, 3d6+8, 5d20+12, 80d100-50, etc.\n"
+	fmt.Println(example + exampleMessage)
+}

commands/command_help.go

@@ -9,12 +9,26 @@ func commandHelp(s *State) error {
 	commands := BuildCommands()
 
 	if len(s.Args) > 1 {
-		cmd := s.Args[1]
-		err := SingleCommandHelp(s, commands, cmd)
-		if err != nil {
-			return err
+		cmd := strings.ToLower(s.Args[1])
+		switch cmd {
+		case "monsters":
+			monstersHelp()
+			return nil
+		case "npcs":
+			npcHelp()
+			return nil
+		case "quests":
+			questsHelp()
+			return nil
+		case "places":
+			placesHelp()
+			return nil
+		case "dice":
+			diceHelp()
+		case "help":
+			helpHelp()
+			return nil
 		}
-		return nil
 	}
 
 	intro := "Welcome to Lore!\n"
@@ -30,29 +44,10 @@ func commandHelp(s *State) error {
 	return nil
 }
 
-func SingleCommandHelp(
-	s *State,
-	commands map[string]Command,
-	cmdName string,
-) error {
+func helpHelp() {
 	intro := "Welcome to Lore!\n"
-	introMsg := fmt.Sprintf("The %s command has the following flags: ", cmdName)
+	introMsg := fmt.Sprintf("The %s command has the following flags: ", "help")
 	fmt.Println(header.Render(intro + introMsg))
-	commandDiv := ""
-	cmd, ok := commands[cmdName]
-	if !ok {
-		return fmt.Errorf("That command does not exist in Lore!")
-	}
-
-	if cmd.Name == "help" {
-		commandDiv += "The help subcommand helps you. It's helping right now!"
-	}
-
-	for key, val := range cmd.Flags {
-		name := bold.Render(fmt.Sprintf("%-13s", key))
-		desc := italic.Render(val)
-		commandDiv += fmt.Sprintf("%s <==> %v\n", name, desc)
-	}
+	commandDiv := "The help subcommand helps you. It's helping right now!"
 	fmt.Println(commandBox.Render(strings.TrimRight(commandDiv, "\n")))
-	return nil
 }

commands/command_monsters.go

@@ -145,6 +145,8 @@ func simulateFight(monsterOne, monsterTwo dndapi.Monster) {
 	firstAttacks := first.ParseAttacks()
 	secondAttacks := second.ParseAttacks()
 
+	var winner *dndapi.Monster
+
 	for hpOne > 0 && hpTwo > 0 {
 		firstAttack := dndapi.UseRandomAttack(firstAttacks)
 		secondAttack := dndapi.UseRandomAttack(secondAttacks)
@@ -169,6 +171,10 @@ func simulateFight(monsterOne, monsterTwo dndapi.Monster) {
 			)
 		}
 		hpTwo -= firstDamage
+		if hpTwo <= 0 {
+			hpTwo = 0
+			winner = &monsterOne
+		}
 		fmt.Print(firstMessage)
 		time.Sleep(time.Millisecond * 800)
 
@@ -188,13 +194,18 @@ func simulateFight(monsterOne, monsterTwo dndapi.Monster) {
 			)
 		}
 		hpOne -= secondDamage
+		if hpOne <= 0 {
+			hpOne = 0
+			winner = &monsterTwo
+		}
 		fmt.Print(secondMessage)
 		time.Sleep(time.Millisecond * 800)
 
 		fmt.Printf("%s HP Remaining: %d, %s HP Remaining: %d\n",
 			first.Name, hpOne, second.Name, hpTwo)
 		time.Sleep(time.Millisecond * 1000)
 	}
+	fmt.Printf("%s won the battle!\n", winner.Name)
 }
 
 func parseDamage(