feat(readme): Readme updates

Signed-off-by: dark0dave <dark0dave@mykolab.com>

Author: dark0dave

cmd/file-view.go

@@ -32,21 +32,9 @@ type fileview struct {
 	title    string
 	content  string
 	viewport viewport.Model
-	callback func() (tea.Model, tea.Cmd)
 }
 
-func NewFileView(content string, title string, callback func() (tea.Model, tea.Cmd)) fileview {
-	f := fileview{title: title, content: content, callback: callback}
-	headerHeight := lipgloss.Height(f.headerView())
-	footerHeight := lipgloss.Height(f.footerView())
-	verticalMarginHeight := headerHeight + footerHeight
-	f.viewport = viewport.New(width, height-verticalMarginHeight)
-	f.viewport.YPosition = headerHeight
-	f.viewport.SetContent(f.content)
-	return f
-}
-
-func NewFileViewFromFile(path string, callback func() (tea.Model, tea.Cmd)) fileview {
+func NewFileView(path string) fileview {
 	content := ""
 	if filepath.Ext(path) == ".are" {
 		f, err := os.Open(path)
@@ -68,28 +56,42 @@ func NewFileViewFromFile(path string, callback func() (tea.Model, tea.Cmd)) file
 			content = ""
 		}
 	}
-	return NewFileView(content, filepath.Base(path), callback)
+	f := fileview{title: filepath.Base(path), content: content}
+	headerHeight := lipgloss.Height(f.headerView())
+	footerHeight := lipgloss.Height(f.footerView())
+	verticalMarginHeight := headerHeight + footerHeight
+	f.viewport = viewport.New(width, height-verticalMarginHeight)
+	f.viewport.YPosition = headerHeight
+	f.viewport.SetContent(f.content)
+	return f
 }
 
 func (f fileview) Init() tea.Cmd {
 	return nil
 }
 
 func (f fileview) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
-	var cmd tea.Cmd
+	var (
+		cmd  tea.Cmd
+		cmds []tea.Cmd
+	)
 
 	switch msg := msg.(type) {
 	case tea.KeyMsg:
 		if k := msg.String(); k == "ctrl+c" || k == "q" || k == "esc" {
-			return f.callback()
+			return f, tea.Quit
 		}
 
 	case tea.WindowSizeMsg:
 		setViewport(f, msg)
 	}
 
+	// Handle keyboard and mouse events in the viewport
 	f.viewport, cmd = f.viewport.Update(msg)
-	return f, cmd
+	// Send an extra WindowSize to update
+	cmds = append(cmds, cmd)
+
+	return f, tea.Batch(cmds...)
 }
 
 func setViewport(f fileview, msg tea.WindowSizeMsg) {

cmd/list-varriables.go

@@ -17,18 +17,23 @@ var baseStyle = lipgloss.NewStyle().
 	BorderForeground(lipgloss.Color("240"))
 
 type listVariables struct {
-	table table.Model
+	heading []string
+	table   table.Model
 }
 
 func generateRows(path string, file fs.FileInfo) *[]table.Row {
 	rows := []table.Row{}
-	fileContent, err := util.ReadFileToString(path)
+	fileContent, err := util.ReadFileToString(filepath.Join(path, file.Name()))
 	if err != nil {
 		return &rows
 	}
 	variables, err := translation.FromFileContents(fileContent)
 	if err == nil {
-		lang := filepath.Base(filepath.Dir(path))
+		lang_path := strings.Split(path, "/")
+		lang := ""
+		if len(lang_path) > 2 {
+			lang = lang_path[len(lang_path)-2]
+		}
 		for _, v := range *variables {
 			rows = append(rows, table.Row{file.Name(), lang, v.Identifier, v.Value})
 		}
@@ -38,18 +43,18 @@ func generateRows(path string, file fs.FileInfo) *[]table.Row {
 
 func NewList(path string) listVariables {
 	columns := []table.Column{
-		{Title: "FileName", Width: int(0.2 * float64(width))},
-		{Title: "Lang", Width: int(0.1 * float64(width))},
-		{Title: "Id", Width: int(0.05 * float64(width))},
-		{Title: "Value", Width: int(0.55 * float64(width))},
+		{Title: "FileName", Width: 12},
+		{Title: "Lang", Width: 8},
+		{Title: "Id", Width: 4},
+		{Title: "Value", Width: 40},
 	}
 	rows := []table.Row{}
 	filepath.WalkDir(path, func(path string, file fs.DirEntry, err error) error {
 		if err != nil {
 			return err
 		}
 		ext := filepath.Ext(file.Name())
-		if !file.IsDir() && strings.ToLower(ext) == ".tra" {
+		if !file.IsDir() && ext == ".tra" {
 			info, _ := file.Info()
 			file_rows := *generateRows(path, info)
 			rows = append(rows, file_rows...)
@@ -62,7 +67,7 @@ func NewList(path string) listVariables {
 		table.WithColumns(columns),
 		table.WithRows(rows),
 		table.WithFocused(true),
-		table.WithHeight(height-7),
+		table.WithHeight(7),
 	)
 
 	s := table.DefaultStyles()
@@ -86,24 +91,6 @@ func (l listVariables) Init() tea.Cmd { return nil }
 func (l listVariables) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	var cmd tea.Cmd
 	switch msg := msg.(type) {
-	case tea.WindowSizeMsg:
-		h, w := docStyle.GetFrameSize()
-		h1, w1 := baseStyle.GetFrameSize()
-		h += h1
-		w += w1
-		if msg.Height > h {
-			l.table.SetHeight(msg.Height - h)
-		}
-		if msg.Width > w {
-			ratio := float64(msg.Width - w)
-			l.table.SetColumns([]table.Column{
-				{Title: "FileName", Width: int(0.2 * ratio)},
-				{Title: "Lang", Width: int(0.1 * ratio)},
-				{Title: "Id", Width: int(0.05 * ratio)},
-				{Title: "Value", Width: int(0.55 * ratio)},
-			})
-			l.table.SetWidth(int(ratio))
-		}
 	case tea.KeyMsg:
 		switch msg.String() {
 		case "esc":
@@ -112,26 +99,19 @@ func (l listVariables) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 			} else {
 				l.table.Focus()
 			}
-		case "q", "ctrl+c", "ctrl+d":
+		case "q", "ctrl+c":
 			return l, tea.Quit
 		case "enter":
-			content := ""
+			l.heading = []string{""}
 			counter := 0
-			for _, s := range strings.Split(l.table.SelectedRow()[3], " ") {
+			for _, s := range strings.Split(l.table.SelectedRow()[2], " ") {
 				counter += len(s)
 				if counter >= 42 {
-					content += "\n"
+					l.heading = append(l.heading, "\n")
 					counter = 0
-				} else if strings.Trim(content, " ") != "" {
-					content += " "
 				}
-				content += s
+				l.heading = append(l.heading, s)
 			}
-			title := strings.Join(l.table.SelectedRow()[:3], " ")
-			f := NewFileView(content, title, func() (tea.Model, tea.Cmd) {
-				return l, cmd
-			})
-			return f, f.Init()
 		}
 	}
 	l.table, cmd = l.table.Update(msg)
@@ -140,5 +120,12 @@ func (l listVariables) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 
 func (l listVariables) View() string {
 	body := []string{l.table.View(), "\n\n", l.table.HelpView(), " enter"}
-	return baseStyle.Render(body...)
+	if len(l.heading) == 0 {
+		return baseStyle.Render(body...)
+	} else {
+		payload := l.heading
+		payload = append(payload, "\n")
+		payload = append(payload, body...)
+		return baseStyle.Render(payload...)
+	}
 }

cmd/tree.go

@@ -86,9 +86,7 @@ func (n nested) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		case "e", "enter":
 			nodes := n.tree.Nodes()
 			node, _ := getSelected(&n, &nodes, 0)
-			f := NewFileViewFromFile(node.Desc, func() (tea.Model, tea.Cmd) {
-				return n, nil
-			})
+			f := NewFileView(node.Desc)
 			return f, f.Init()
 		}
 	}

docs/discover.gif

@@ -8,7 +8,6 @@ require (
 	github.com/charmbracelet/lipgloss v0.13.0
 	github.com/dark0dave/infinity_file_formats v0.0.0-20241126215235-54369c958d54
 	github.com/savannahostrowski/tree-bubble v0.0.0-20230724043728-d7bb06a8a67e
-	golang.org/x/text v0.3.8
 )
 
 require (
@@ -31,4 +30,5 @@ require (
 	github.com/ulikunitz/xz v0.5.12 // indirect
 	golang.org/x/sync v0.8.0 // indirect
 	golang.org/x/sys v0.27.0 // indirect
+	golang.org/x/text v0.3.8 // indirect
 )

docs/example.gif

@@ -3,11 +3,6 @@ package translation
 import (
 	"errors"
 	"fmt"
-	"unicode"
-
-	"golang.org/x/text/runes"
-	"golang.org/x/text/transform"
-	"golang.org/x/text/unicode/norm"
 )
 
 var (
@@ -41,14 +36,6 @@ func (v *Variable) end() int {
 	return v.valueEnd
 }
 
-func ToAscii(str string) string {
-	result, _, err := transform.String(transform.Chain(norm.NFD, runes.Remove(runes.In(unicode.Mn))), str)
-	if err != nil {
-		return ""
-	}
-	return result
-}
-
 func FromString(s string, start int) (*Variable, error) {
 	v := &Variable{}
 	for i := start; i < len(s); i++ {
@@ -72,7 +59,7 @@ func FromString(s string, start int) (*Variable, error) {
 		// "~" is 126
 		if v.isRecording() && s[i] == 126 {
 			v.valueEnd = i
-			v.Value = ToAscii(s[v.valueStart:v.valueEnd])
+			v.Value = s[v.valueStart:v.valueEnd]
 			v.toggleRecording()
 			break
 		}

docs/traverse.gif

@@ -29,14 +29,6 @@ func TestString(t *testing.T) {
 			testString: "@123 test string~",
 			error:      ErrValue,
 		},
-		{
-			expected: &Variable{
-				Identifier: "0",
-				Value:      "Aboleth le�� ve sv� n�dr�i, mimo dosah tv�ch zbran�. Mus� naj�t jin� zp�sob, jak zni�it mechanismus, kter� ho dr�� na�ivu.",
-			},
-			testString: "@0    = ~Aboleth le�� ve sv� n�dr�i, mimo dosah tv�ch zbran�. Mus� naj�t jin� zp�sob, jak zni�it mechanismus, kter� ho dr�� na�ivu.~",
-			error:      nil,
-		},
 	}
 	for _, tc := range testCases {
 		v, err := FromString(tc.testString, 0)

go.mod

@@ -6,11 +6,23 @@
 [![](https://img.shields.io/github/actions/workflow/status/dark0dave/infinity_dialog/main.yaml?style=for-the-badge)](https://github.com/dark0dave/infinity_dialog/actions/workflows/main.yaml)
 [![](https://img.shields.io/github/license/dark0dave/infinity_dialog?style=for-the-badge)](./LICENSE)
 
-This tool interacts with .tra files used in infinity engine mods. Currently we walk a directory of a mod and allow you to browse the strings.
+This tool has 2 features, traverse and discover. Traverse walks over a bg mod and shows you the tree of paths through the files. Discover shows all the strings for all languages and where they are set.
 
-## Demo
+### Traverse
 
-![](./docs/example.gif)
+This feature lets you see the paths through your mod by parsing the area + baf files.
+
+#### Demo
+
+![](./docs/traverse.gif)
+
+### Discover
+
+This feature interacts with .tra files used in infinity engine mods. Currently we walk a directory of a mod and allow you to browse the strings.
+
+#### Demo
+
+![](./docs/discover.gif)
 
 ## Run