progress

package

v0.5.0 Latest Latest Go to latest Published: Jun 13, 2026 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/StrangeNoob/nvim-quest

Links

Open Source Insights

Documentation ¶

Overview ¶

Package progress persists the player's journey to a versioned JSON file.

Index ¶

Constants
func DefaultPath() string
func Save(path string, p *Progress) error
type Progress
- func Load(path string) *Progress
- func New() *Progress

Constants ¶

View Source

const Version = 2

Variables ¶

This section is empty.

Functions ¶

func DefaultPath ¶

func DefaultPath() string

DefaultPath is ~/.nvim-quest/progress.json.

func Save ¶

func Save(path string, p *Progress) error

Types ¶

type Progress ¶

type Progress struct {
	Version    int            `json:"version"`
	XP         int            `json:"xp"`
	Level      int            `json:"level"`
	Stars      map[string]int `json:"stars"`
	Completed  []string       `json:"completed"`
	Badges     []string       `json:"badges"`
	LastLesson string         `json:"lastLesson"`
}

func Load ¶

func Load(path string) *Progress

Load never fails: missing, corrupt, or old-version files yield a fresh Progress (old files are kept as <path>.v1.bak).

func New ¶

func New() *Progress

func (*Progress) AddBadge ¶

func (p *Progress) AddBadge(name string)

func (*Progress) HasBadge ¶

func (p *Progress) HasBadge(name string) bool

func (*Progress) IsCompleted ¶

func (p *Progress) IsCompleted(id string) bool

func (*Progress) MarkCompleted ¶

func (p *Progress) MarkCompleted(id string)

Source Files ¶

View all Source files

progress.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL