zwindler / gocastle

GoCastle

Introduction

This project is my journey to creating a graphical game while learning Golang

Every session, I'll add an entry in this file telling what I did and what I learned (see developpement_diary/)

Prerequisites

sudo apt-get install golang gcc libgl1-mesa-dev xorg-dev

Also, for building releases, you need goreleaser and fyne-cross

go install github.com/fyne-io/fyne-cross@latest

For the development, you need to install Golangci-lint

Contributions

Contributions are welcome but I need you to follow a few rules:

• the primary goal of this project is for me to learn Go while having fun (game dev is so much fun). Keep that in mind when asking / proposing modifications.
• since I'm a beginner, my code quality can be improved and I've a lot to learn. Fixing my code where it's badly written or helping me learn better patterns is greatly appreciated, but please add a little context/explaination so I can grow from your contributions. See developpement_diary/ folder.
• most of the future work for the game is written in the Issues of this project. You look at them and ask me if you can take those!
  • issues labelled "game design" are by default reserved to me (@zwindler) since this needs not only code but also thinking about how the game will work.
  • issues labelled "good first issues" are self explainatory ;-).
  • issues labelled "on hold" as well.
  • issues labelled "refactoring" need to be discussed first. I openned a Discord server for this, please ask me the details.

Most importantly, have fun!

Build, test, release

Build only

make build

Build and run (useful in dev)

make buildrun

Release (using goreleaser)

git tag -a 0.0.1 -m "0.0.1 release"
goreleaser --clean

Test release (against code not tagged)

goreleaser --snapshot --clean

Note: for darwin compilation, we need fyne-cross which requires having locally the XCode SDK, especially Command_Line_Tools_for_Xcode_12.4.dmg. Download it here. See fyne-cross documentation for more information.

gocastle's Issues

feat: "Fog of war" in dungeons

fix: sometime, some elements are not rendered

Often it's the map or one of the scrolls on the map. Need to quit the game

chore: move maps to pkg

fix: remove inventory object images from save

feat: inventory screen / implement a "show details" button

Right now, in the inventory you can only pick items up and equip them

We need to add a small button that will show basic stats on the object (maybe a popup)

feat: NPCs fighting back

fix: The first log that disapeers and cause scroll to appear in logs doesn't auto scroll to the bottom

chore: in maps/maps.go, change SpawnNPC coordinates from int to Coord struct

// This structure helps putting NPCs on the map in a mon concise way
// This will only be used to populate NPCList using AddNPCs() function
type SpawnNPC []struct {
	npc  model.NPCStats
	// TODO, change this to Coord type
	x, y int
}

fix: fyne-cross won't compile darwin targets

See fyne-io/fyne-cross#187

feat: merchants / stores

fix: issue with player collision (DontCollideWithPlayer()) since I moved it in npc.go

chore: rework initialization of map, merge things from newgame / loadgame to be more consistent

fix: errors when starting the game

2023/07/17 21:37:06 Fyne error:  Attempt to access current Fyne app when none is started
2023/07/17 21:37:06   At: /home/zwindler/go/pkg/mod/fyne.io/fyne/[email protected]/app.go:104
2023/07/17 21:37:06 Fyne error:  Attempt to access current Fyne app when none is started
2023/07/17 21:37:06   At: /home/zwindler/go/pkg/mod/fyne.io/fyne/[email protected]/app.go:104
2023/07/17 21:37:06 Fyne error:  Attempt to access current Fyne app when none is started
2023/07/17 21:37:06   At: /home/zwindler/go/pkg/mod/fyne.io/fyne/[email protected]/app.go:104
2023/07/17 21:37:06 Fyne error:  Attempt to access current Fyne app when none is started
2023/07/17 21:37:06   At: /home/zwindler/go/pkg/mod/fyne.io/fyne/[email protected]/app.go:104

chore: embed all static files in order to be able to use `fyne package` and fyne-cross

https://pkg.go.dev/embed@master

feat: spells

feat: inventory screen / refresh inventory when picking up an object

chore: move model to pkg

chore: save game + load game should open current gocastle binary folder

chore: you should only be able to create .sav files in save game

fix: Weight is not properly displayed in inventory screen (or even computed?)

feat: consumables

fix: load game doesn't displays avatars anymore (regression)

Since working with embed I guess

chore: decide whether char stats are int or uints or not

fix: stats box is at 0 when game start

chore: rework "To The Old Mine" map

See

fix: view is not centered on player anymore when ShowGameScreen() is ran

I'm pretty confident it was working before thoug so this is a regression

This should work since we run centerMapOnPlayer() at the end of ShowGameScreen()

chore: move utils to pkg (or internal?)

feat: map transitions (being able to go from map to map)

chore: move model/theme.go outside of model package and make is a package in pkg/

feat: map generation

chore: move items spawn in maps package

put it in map like spawnNPC, not in initGame

chore: don't change default directory location for save/load on iOS, Android, Flatpak

fix: save doesn't include time spent

feat: adding items on the floor and have the ability to pick them up / drop them down

fix: unable to compile gocastle on windows, darwin, arm64 targets

Since GoCastle is now "playable" (even though really boring + short), I've added goreleaser and my first release . I'm a bit disappointed though because Windows + Mac + ARM64 targets all failed

        imports github.com/go-gl/gl/v3.2-core/gl: build constraints exclude all Go files in /home/zwindler/go/pkg/mod/github.com/go-gl/[email protected]/v3.2-core/gl

See fyne-io/fyne#1739

chore: move screens to pkg

fix: load doesn't properly recreate Avatars, Inventory, ...

feat: infos on a given tile (name of the NPC if there is one, does he/it looks bad, ...)

Ideally, when the player clicks right on a tile, we need to display a small popup to give basic information on what is on that tile:

• object
• npc (name and how badly it's hurt)
• what type of floor it is

For the last one, we need to add a small comment for each tile in the struct

chore: Change NPCsOnCurrentMap to []NPCStats

type NPCsOnCurrentMap struct {
	List []NPCStats
}

fix: wrong pointer on knife

When trying to get the knife from the floor, player gains a blunt sword

chore: Prettify Village Map (add a square at the center of the village + sandy roads)

See

fix: goreleaser doesn't play along with fyne-cross

chore: find a clean way to do some cicd

chore: In new game screen, buttons Back and Validate are weird

chore: Emoji support still missing (fyne 2.4)

chore: take a look at packaging options

https://developer.fyne.io/started/packaging

feat: add a menu bar on top to help navigate

Add things like:

• Game
  • Save
  • Load
  • Quit
• Inventory
• Character (to display character stats / level up)

chore: move npc to pkg

chore: Create "The Old Mine" map

chore: try to improve performance by generating maps as 1 PNG trop the tilemap

Performance is really poor right now, maps takes a lot of time to display on laptops and even more on mobile devices, probably due to fyne not being designed to display thousands of individual images. On my desktop, I didn't "see" the issue, map transitions take <200 ms to display. On my laptop though, it's >500ms and even worse on my smartphone.

This may (or may not) be a reason for #4

In order to make things more efficient, I had the idea to create the full map as one image for fyne instead of thousand of little ones. For pre-generated maps, it's "easy", I could do it by hand once I'm satisfied with how they look. But for generated maps, it's not possible.

So I have to modify the code to stop using a huge matrix containing lots of tiny images and generate the big map with all the tiles on the fly.

To make sure this is a good idea, I also have to check how long it takes to generate the whole map because Fog Of War implies that we have to regenerate the map PNG every time the player reveals more of the map.