add help screen, use keymap

keymap.go

@@ -0,0 +1,78 @@
+package main
+
+import "github.com/charmbracelet/bubbles/key"
+
+type keyMap struct {
+	Up      key.Binding
+	Down    key.Binding
+	Left    key.Binding
+	Right   key.Binding
+	Help    key.Binding
+	Quit    key.Binding
+	Gather  key.Binding
+	Pickup  key.Binding
+	Destroy key.Binding
+	Place   key.Binding
+	Craft   key.Binding
+}
+
+// ShortHelp returns keybindings to be shown in the mini help view. It's part
+// of the key.Map interface.
+func (k keyMap) ShortHelp() []key.Binding {
+	return []key.Binding{k.Help, k.Quit}
+}
+
+// FullHelp returns keybindings for the expanded help view. It's part of the
+// key.Map interface.
+func (k keyMap) FullHelp() [][]key.Binding {
+	return [][]key.Binding{
+		{k.Up, k.Down, k.Left, k.Right, k.Gather, k.Place, k.Craft, k.Destroy, k.Pickup, k.Help, k.Quit}, //second column
+	}
+}
+
+var keys = keyMap{
+	Up: key.NewBinding(
+		key.WithKeys("up", "k"),
+		key.WithHelp("↑/k", "move up"),
+	),
+	Down: key.NewBinding(
+		key.WithKeys("down", "j"),
+		key.WithHelp("↓/j", "move down"),
+	),
+	Left: key.NewBinding(
+		key.WithKeys("left", "h"),
+		key.WithHelp("←/h", "move left"),
+	),
+	Right: key.NewBinding(
+		key.WithKeys("right", "l"),
+		key.WithHelp("→/l", "move right"),
+	),
+	Help: key.NewBinding(
+		key.WithKeys("?"),
+		key.WithHelp("?", "toggle help"),
+	),
+	Quit: key.NewBinding(
+		key.WithKeys("esc", "ctrl+c"),
+		key.WithHelp("ctrl+c", "quit"),
+	),
+	Gather: key.NewBinding(
+		key.WithKeys("g"),
+		key.WithHelp("g", "gather tile resource"),
+	),
+	Pickup: key.NewBinding(
+		key.WithKeys(","),
+		key.WithHelp(",", "pickup object"),
+	),
+	Destroy: key.NewBinding(
+		key.WithKeys("x"),
+		key.WithHelp("x", "destroy tile object "),
+	),
+	Place: key.NewBinding(
+		key.WithKeys("p"),
+		key.WithHelp("p", "place object"),
+	),
+	Craft: key.NewBinding(
+		key.WithKeys("c"),
+		key.WithHelp("c", "craft object"),
+	),
+}

mainscreen.go

@@ -7,20 +7,25 @@ import (
 	"time"
 
 	sim "git.saintnet.tech/stryan/spacetea/simulator"
+	"github.com/charmbracelet/bubbles/help"
+	"github.com/charmbracelet/bubbles/key"
 	"github.com/charmbracelet/bubbles/textinput"
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/charmbracelet/lipgloss"
 )
 
 var style = lipgloss.NewStyle().
-	Width(24).
+	Width(32).
 	Align(lipgloss.Center).
+	Foreground(lipgloss.Color("#F0FFFF")).
 	BorderStyle(lipgloss.NormalBorder()).
 	BorderForeground(lipgloss.Color("63"))
 
 type model struct {
 	s     *sim.Simulator
 	input textinput.Model
+	help  help.Model
+	keys  keyMap
 	next  string
 }
 
@@ -50,6 +55,8 @@ func initMainscreen() model {
 	return model{
 		s:     simulator,
 		input: ti,
+		help:  help.New(),
+		keys:  keys,
 	}
 }
 func (m model) Init() tea.Cmd {
@@ -62,6 +69,8 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	case beat:
 		//heartbeat
 		return m, heartbeat()
+	case tea.WindowSizeMsg:
+		m.help.Width = msg.Width
 	case placeMsg:
 		simc := fmt.Sprintf("place %v", string(msg))
 		m.s.Input(simc)
@@ -71,61 +80,47 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		m.s.Input(simc)
 		return m, nil
 	case tea.KeyMsg:
-		switch msg.Type {
+		switch {
-		case tea.KeyCtrlC:
+		case key.Matches(msg, m.keys.Help):
+			m.help.ShowAll = !m.help.ShowAll
+			return m, nil
+		case key.Matches(msg, m.keys.Quit):
 			m.s.Stop()
 			return m, tea.Quit
-		case tea.KeyEnter:
+		case key.Matches(msg, m.keys.Right):
-			m.s.Input(m.input.Value())
-			m.input.Reset()
-			return m, nil
-		case tea.KeyRight:
 			m.s.Input("right")
 			return m, nil
-		case tea.KeyLeft:
+		case key.Matches(msg, m.keys.Left):
 			m.s.Input("left")
 			return m, nil
-		case tea.KeyUp:
+		case key.Matches(msg, m.keys.Up):
 			m.s.Input("up")
 			return m, nil
-		case tea.KeyDown:
+		case key.Matches(msg, m.keys.Down):
 			m.s.Input("down")
 			return m, nil
-		case tea.KeyCtrlF:
+		case key.Matches(msg, m.keys.Gather):
-			if m.input.Focused() {
+			m.s.Input("get")
-				m.input.Blur()
+		case key.Matches(msg, m.keys.Place):
-			} else {
+			var res entrylist
-				m.input.Focus()
+			for _, k := range sim.GlobalItems {
-			}
+				if m.s.Player.Resources[k.ID()] != 0 {
-			return m, nil
+					res = append(res, k.(sim.ItemEntry))
-		case tea.KeyRunes:
-			if !m.input.Focused() {
-				switch msg.String() {
-				case "g":
-					m.s.Input("get")
-				case "p":
-					var res entrylist
-					for _, k := range sim.GlobalItems {
-						if m.s.Player.Resources[k.ID()] != 0 {
-							res = append(res, k.(sim.ItemEntry))
-						}
-					}
-					sort.Sort(res)
-					return newMenuModel(res, placeMenu), nil
-				case ",":
-					m.s.Input("pickup")
-				case "x":
-					m.s.Input("destroy")
-				case "c":
-					var res entrylist
-					for k := range m.s.Player.Craftables {
-						res = append(res, sim.GlobalItems[k].(sim.ItemEntry))
-					}
-					sort.Sort(res)
-					return newMenuModel(res, craftMenu), nil
 				}
-				return m, nil
 			}
+			sort.Sort(res)
+			return newMenuModel(res, placeMenu), nil
+		case key.Matches(msg, m.keys.Pickup):
+			m.s.Input("pickup")
+		case key.Matches(msg, m.keys.Destroy):
+			m.s.Input("destroy")
+		case key.Matches(msg, m.keys.Craft):
+			var res entrylist
+			for k := range m.s.Player.Craftables {
+				res = append(res, sim.GlobalItems[k].(sim.ItemEntry))
+			}
+			sort.Sort(res)
+			return newMenuModel(res, craftMenu), nil
 		}
 	}
 	m.input, cmd = m.input.Update(msg)
@@ -135,9 +130,13 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 
 func (m model) View() string {
 	var render string
-	playerAndLog := lipgloss.JoinVertical(0, style.Render(fmt.Sprintf("%v", m.s.Player.String())), style.Render(fmt.Sprintf("%v", m.s.Player.Log())))
+	if m.help.ShowAll != true {
-	placeAndInput := lipgloss.JoinVertical(0, style.Render(m.s.Place.String()), style.Render(m.input.View()))
+		playerAndLog := lipgloss.JoinVertical(0, style.Render(fmt.Sprintf("%v", m.s.Player.String())), style.Render(fmt.Sprintf("%v", m.s.Player.Log())))
-	display := lipgloss.JoinHorizontal(0, placeAndInput, playerAndLog)
+		placeAndInput := lipgloss.JoinVertical(0, style.Render(m.s.Place.String()), style.Render(m.help.View(m.keys)))
-	render = fmt.Sprintf("%v\n%v\n", style.Render(fmt.Sprintf("Current Time: %v", strconv.Itoa(m.s.Time))), display)
+		display := lipgloss.JoinHorizontal(0, placeAndInput, playerAndLog)
+		render = fmt.Sprintf("%v\n%v\n", style.Render(fmt.Sprintf("Current Time: %v", strconv.Itoa(m.s.Time))), display)
+	} else {
+		render = style.Render(m.help.View(m.keys))
+	}
 	return render
 }