rebase upstream master

.github/workflows/build.yml

@@ -32,7 +32,7 @@ jobs:
       - name: Set up Go environment
         uses: actions/[email protected]
         with:
-          go-version: 1.16
+          go-version: 1.16.5
         id: go
 
       - name: Cache Go modules

Makefile

@@ -28,6 +28,7 @@ setup:
 	@git submodule update --init --recursive
 	@$(GOCMD) get -v -t -d ./...
 	@$(GOCMD) mod download -x
+	@$(GOCMD) get golang.org/x/tools/cmd/stringer
 	@$(GOCMD) install golang.org/x/tools/cmd/stringer
 	@$(GOCMD) generate -v ./...
 

README.md

@@ -3,6 +3,7 @@
 ![Logo](hsassets/images/d2logo.png)
 
 [Join us on Discord!](https://discord.gg/pRy8tdc)\
+[Join us on IRC!](ircs://irc.libera.chat/#opendiablo2)\
 [Development Live stream](https://www.twitch.tv/essial/)\
 [Support us on Patreon](https://www.patreon.com/bePatron?u=37261055)
 

abysswrapper/abysswrapper.go

@@ -48,7 +48,7 @@ func (a *AbyssWrapper) Write(p []byte) (n int, err error) {
 	return n, nil
 }
 
-// Launch launchs abyss wrapper
+// Launch launches abyss wrapper
 func (a *AbyssWrapper) Launch(config *hsconfig.Config, output io.Writer) error {
 	a.mutex.RLock()
 	if a.running {

hsassets/assets.go

@@ -4,7 +4,7 @@ import (
 	_ "embed" // this is standard solution for embed
 )
 
-// these variables are links to existing icones used in project
+// these variables are links to existing icons used in project
 // nolint:gochecknoglobals // go:embed directive works only for globals
 // https://github.com/golangci/golangci-lint/issues/1727
 var (

hscommon/hsfiletypes/filetype.go

@@ -94,9 +94,9 @@ func (f FileType) FileExtension() string {
 
 type fileTypeCheckFn = func(data *[]byte) FileType
 
-// SubtypeCheckFn returns a function to check a file. This is important for
+// subtypeCheckFn returns a function to check a file. This is important for
 // distinguishing between files that share a common file extension.
-func (f FileType) SubtypeCheckFn() fileTypeCheckFn {
+func (f FileType) subtypeCheckFn() fileTypeCheckFn {
 	table := map[FileType]fileTypeCheckFn{
 		FileTypeTBL:            determineSubtypeTBL,
 		FileTypeTBLFontTable:   determineSubtypeTBL,
@@ -114,7 +114,7 @@ func GetFileTypeFromExtension(extension string, data *[]byte) (FileType, error)
 			continue
 		}
 
-		fnDetermine := fileType.SubtypeCheckFn()
+		fnDetermine := fileType.subtypeCheckFn()
 		if fnDetermine == nil {
 			return fileType, nil
 		}

hscommon/hsnode/node.go

@@ -1,4 +1,4 @@
-// Package hsnode contains game nodes
+// Package hsnode contains an implementation of a node graph, as parent and child nodes.
 package hsnode
 
 import "strings"

hscommon/hsutil/datautils.go

@@ -12,9 +12,9 @@ import (
 	"github.com/OpenDiablo2/dialog"
 )
 
-const miliseconds = 1000
+const milliseconds = 1000
 
-// BoolToInt converts bool into 32-bit intager
+// BoolToInt converts bool into 32-bit integer
 // if b is true, then returns 1, else 0
 func BoolToInt(b bool) int32 {
 	if b {
@@ -48,7 +48,7 @@ func ExportToGif(images []*image.RGBA, delay int32) error {
 	// reload static image and construct outGif
 	for _, img := range images {
 		// FROM TUTORIAL:
-		// Read each frame GIF image with gif.Decode. If we read JPEG images, we have to convert them programatically
+		// Read each frame GIF image with gif.Decode. If we read JPEG images, we have to convert them programmatically
 		// (goanigiffy does this by calling gif.Encode and gif.Decode).
 		g := bytes.NewBuffer([]byte{})
 
@@ -63,11 +63,11 @@ func ExportToGif(images []*image.RGBA, delay int32) error {
 		}
 
 		outGif.Image = append(outGif.Image, inGif.(*image.Paletted))
-		outGif.Delay = append(outGif.Delay, int(delay/miliseconds))
+		outGif.Delay = append(outGif.Delay, int(delay/milliseconds))
 	}
 
 	// save gif image
-	file, err := os.OpenFile(filepath.Clean(filePath), os.O_WRONLY|os.O_CREATE, 0o600)
+	file, err := os.OpenFile(filepath.Clean(filePath), os.O_WRONLY|os.O_CREATE, defaultFilePermissions)
 	if err != nil {
 		return fmt.Errorf("error creating a new file: %w", err)
 	}

hsconfig/doc.go

@@ -1,2 +1,2 @@
-// Package hsconfig contains app configs
+// Package hsconfig provides the Hellspawner application config file implementation.
 package hsconfig

hswidget/animdatawidget/widget.go

@@ -73,12 +73,14 @@ func (p *widget) buildAnimationsList() {
 
 	list := make([]giu.Widget, len(keys))
 
+	const imageButtonSize = 13
+
 	for idx, name := range keys {
 		currentIdx := idx
 		list[idx] = giu.Row(
 			hswidget.MakeImageButton(
 				"##"+p.id+"deleteEntry"+strconv.Itoa(currentIdx),
-				13, 13,
+				imageButtonSize, imageButtonSize,
 				state.deleteIcon,
 				func() {
 					p.deleteEntry(state.mapKeys[currentIdx])

hswidget/cofwidget/state.go

@@ -130,7 +130,7 @@ func (s *widgetState) Decode(data []byte) {
 		return
 	}
 
-	s.selectable = (selectable == 1)
+	s.selectable = selectable == 1
 
 	transparent, err := sr.ReadByte()
 	if err != nil {
@@ -139,7 +139,7 @@ func (s *widgetState) Decode(data []byte) {
 		return
 	}
 
-	s.transparent = (transparent == 1)
+	s.transparent = transparent == 1
 
 	s.drawEffect, err = sr.ReadInt32()
 	if err != nil {

hswidget/cofwidget/widget.go

@@ -421,12 +421,12 @@ func (p *widget) makeAddLayerLayout() giu.Layout {
 
 	drawEffectList := make([]string, d2enum.DrawEffectNone+1)
 	for i := d2enum.DrawEffectPctTransparency25; i <= d2enum.DrawEffectNone; i++ {
-		drawEffectList[int(i)] = strconv.Itoa(int(i)) + " (" + i.String() + ")"
+		drawEffectList[i] = strconv.Itoa(int(i)) + " (" + i.String() + ")"
 	}
 
 	weaponClassList := make([]string, d2enum.WeaponClassTwoHandToHand+1)
 	for i := d2enum.WeaponClassNone; i <= d2enum.WeaponClassTwoHandToHand; i++ {
-		weaponClassList[int(i)] = i.String() + " (" + i.Name() + ")"
+		weaponClassList[i] = i.String() + " (" + i.Name() + ")"
 	}
 
 	return giu.Layout{

hswidget/dc6widget/widget.go

@@ -118,7 +118,9 @@ func (p *widget) makeViewerLayout() giu.Layout {
 				imgui.SliderInt("Frames", &viewerState.controls.frame, 0, int32(p.dc6.FramesPerDirection-1))
 			}
 
-			imgui.SliderInt("Scale", &viewerState.controls.scale, 1, 8)
+			const minScale, maxScale = 1, 8
+
+			imgui.SliderInt("Scale", &viewerState.controls.scale, minScale, maxScale)
 
 			imgui.EndGroup()
 		}),

hswidget/dccwidget/doc.go

@@ -1,3 +1,2 @@
-// Package dccwidget contains stuff responsible for
-// viewing and editing DCC structures
+// Package dccwidget contains stuff responsible for viewing and editing the DCC data structure
 package dccwidget

hswidget/dccwidget/state.go

@@ -114,15 +114,15 @@ func (s *widgetState) Decode(data []byte) {
 		return
 	}
 
-	s.isPlaying = (isPlaying == 1)
+	s.isPlaying = isPlaying == 1
 
 	repeat, err := sr.ReadByte()
 	if err != nil {
 		log.Print(err)
 		return
 	}
 
-	s.repeat = (repeat == 1)
+	s.repeat = repeat == 1
 
 	s.tickTime, err = sr.ReadInt32()
 	if err != nil {

hswidget/dccwidget/widget.go

@@ -105,7 +105,9 @@ func (p *widget) Build() {
 				imgui.SliderInt("Frames", &viewerState.controls.frame, 0, int32(p.dcc.FramesPerDirection-1))
 			}
 
-			imgui.SliderInt("Scale", &viewerState.controls.scale, 1, 8)
+			const minScale, maxScale = 1, 8
+
+			imgui.SliderInt("Scale", &viewerState.controls.scale, minScale, maxScale)
 
 			imgui.EndGroup()
 		}),

hswidget/doc.go

@@ -1,2 +1,2 @@
-// Package hswidget contains widgets for each editor
+// Package hswidget contains a generic editor widget implementation, along with with concrete editor implementations.
 package hswidget

hswidget/ds1widget/doc.go

@@ -1,3 +1,2 @@
-// Package ds1widget provides a giu.Widget implementation for viewing and editing
-// the DS1 files.
+// Package ds1widget provides a giu.Widget for viewing and editing the DS1 data structure.
 package ds1widget

hswidget/ds1widget/widget.go

@@ -333,11 +333,10 @@ func (p *widget) makeObjectLayout(state *widgetState) giu.Layout {
 	}
 
 	if len(obj.Paths) > 0 {
-		l = append(
-			l,
-			giu.Dummy(1, 16),
-			p.makePathLayout(state, obj),
-		)
+		const spacerHeight = 16
+
+		vspace := giu.Dummy(1, spacerHeight)
+		l = append(l, vspace, p.makePathLayout(state, obj))
 	}
 
 	return l

hswidget/dt1widget/doc.go

@@ -1,3 +1,2 @@
-// Package dt1widget contains data about dt1 widget, necessary to
-// edit and view dt1 file structure
+// Package dt1widget contains a giu widget implementation for viewing and editing the dt1 data structure
 package dt1widget

hswidget/dt1widget/state.go

@@ -91,7 +91,7 @@ func (s *widgetState) Decode(data []byte) {
 		return
 	}
 
-	s.showGrid = (showGrid == 1)
+	s.showGrid = showGrid == 1
 
 	showFloor, err := sr.ReadByte()
 	if err != nil {
@@ -100,7 +100,7 @@ func (s *widgetState) Decode(data []byte) {
 		return
 	}
 
-	s.showFloor = (showFloor == 1)
+	s.showFloor = showFloor == 1
 
 	showWall, err := sr.ReadByte()
 	if err != nil {
@@ -109,7 +109,7 @@ func (s *widgetState) Decode(data []byte) {
 		return
 	}
 
-	s.showWall = (showWall == 1)
+	s.showWall = showWall == 1
 
 	s.subtileFlag, err = sr.ReadInt32()
 	if err != nil {

hswidget/dt1widget/sub_tile_flags.go

@@ -33,11 +33,11 @@ func subTileString(subtile int32) string {
 
 func getFlagFromPos(x, y int) int {
 	var subtileLookup = [5][5]int{
-		{20, 21, 22, 23, 24},
-		{15, 16, 17, 18, 19},
-		{10, 11, 12, 13, 14},
-		{5, 6, 7, 8, 9},
 		{0, 1, 2, 3, 4},
+		{5, 6, 7, 8, 9},
+		{10, 11, 12, 13, 14},
+		{15, 16, 17, 18, 19},
+		{20, 21, 22, 23, 24},
 	}
 
 	return subtileLookup[y][x]