nonogram

package

v1.2.0 Latest Latest Go to latest Published: Feb 12, 2026 License: MIT Imports: 10 Imported by: 0

Details

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

Repository

github.com/FelineStateMachine/puzzletea

Links

Open Source Insights

README ¶

Nonogram

Fill cells to match row and column hints, revealing a hidden pattern.

Nonogram gameplay

How to Play

Navigate the grid and fill or mark cells based on the numeric hints along each row and column. The hints tell you how many consecutive filled cells appear in that line, in order. Hints turn green when a row or column is correctly satisfied.

Filled cells count toward hint satisfaction.
Marked cells are visual reminders that a cell should stay empty.
The puzzle is solved when every row and column matches its hints.

Controls

Key	Action
Arrow keys / WASD / hjkl	Move cursor
`z`	Fill cell
`x`	Mark cell
`Backspace`	Clear cell
`Ctrl+H`	Toggle full help
`Ctrl+E`	Toggle debug overlay
`Ctrl+N`	Return to main menu

Modes

Mode	Grid	Density	Description
Easy 5x5	5x5	~35%	Simple hints
Medium 5x5	5x5	~50%	Balanced challenge
Hard 5x5	5x5	~65%	Dense hints
Easy 10x10	10x10	~35%	Simple hints
Medium 10x10	10x10	~50%	Balanced challenge
Hard 10x10	10x10	~65%	Dense hints
Easy 15x15	15x15	~35%	Simple hints
Medium 15x15	15x15	~50%	Balanced challenge
Hard 15x15	15x15	~65%	Dense hints
Easy 20x20	20x20	~35%	Simple hints
Medium 20x20	20x20	~50%	Balanced challenge
Hard 20x20	20x20	~65%	Dense hints

Quick Start

puzzletea new nonogram easy-5x5
puzzletea new nonogram medium-10x10
puzzletea new nonogram hard-20x20

Documentation ¶

Overview ¶

Package nonogram implements the grid-based picture logic puzzle.

Index ¶

Variables
func New(mode NonogramMode, hints Hints) (game.Gamer, error)
type Hints
- func GenerateRandomTomography(mode NonogramMode) Hints
type KeyMap
type Model
- func ImportModel(data []byte) (*Model, error)
type NonogramMode
- func NewMode(title, description string, width, height int, density float64) NonogramMode
- func (n NonogramMode) Spawn() (game.Gamer, error)
type Save
type TomographyDefinition
- func (t TomographyDefinition) RequiredLen() int
- func (t TomographyDefinition) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultKeyMap = KeyMap{
	CursorKeyMap: game.DefaultCursorKeyMap,

	FillTile: key.NewBinding(
		key.WithKeys("z"),
		key.WithHelp("z", "Fill"),
	),
	MarkTile: key.NewBinding(
		key.WithKeys("x"),
		key.WithHelp("x", "Mark"),
	),
	ClearTile: key.NewBinding(
		key.WithKeys("backspace"),
		key.WithHelp("⌫", "Clear"),
	),
}

View Source

var Modes = []list.Item{

	NewMode("Easy 5x5", "5x5 grid, ~65% filled. Dense, constraining hints.", 5, 5, 0.65),
	NewMode("Medium 5x5", "5x5 grid, ~50% filled. Balanced challenge.", 5, 5, 0.50),
	NewMode("Hard 5x5", "5x5 grid, ~35% filled. Sparse, ambiguous hints.", 5, 5, 0.35),

	NewMode("Easy 10x10", "10x10 grid, ~65% filled. Dense, constraining hints.", 10, 10, 0.65),
	NewMode("Medium 10x10", "10x10 grid, ~50% filled. Balanced challenge.", 10, 10, 0.50),
	NewMode("Hard 10x10", "10x10 grid, ~35% filled. Sparse, ambiguous hints.", 10, 10, 0.35),

	NewMode("Easy 15x15", "15x15 grid, ~65% filled. Dense, constraining hints.", 15, 15, 0.65),
	NewMode("Medium 15x15", "15x15 grid, ~50% filled. Balanced challenge.", 15, 15, 0.50),
	NewMode("Hard 15x15", "15x15 grid, ~35% filled. Sparse, ambiguous hints.", 15, 15, 0.35),

	NewMode("Easy 20x20", "20x20 grid, ~65% filled. Dense, constraining hints.", 20, 20, 0.65),
	NewMode("Medium 20x20", "20x20 grid, ~50% filled. Balanced challenge.", 20, 20, 0.50),
	NewMode("Hard 20x20", "20x20 grid, ~35% filled. Sparse, ambiguous hints.", 20, 20, 0.35),
}

Functions ¶

func New ¶

func New(mode NonogramMode, hints Hints) (game.Gamer, error)

Types ¶

type Hints ¶

type Hints struct {
	// contains filtered or unexported fields
}

func GenerateRandomTomography ¶

func GenerateRandomTomography(mode NonogramMode) Hints

type KeyMap ¶

type KeyMap struct {
	game.CursorKeyMap
	FillTile  key.Binding
	MarkTile  key.Binding
	ClearTile key.Binding
}

type Model ¶

type Model struct {
	// contains filtered or unexported fields
}

func ImportModel ¶

func ImportModel(data []byte) (*Model, error)

func (Model) GetDebugInfo ¶

func (m Model) GetDebugInfo() string

func (Model) GetFullHelp ¶

func (m Model) GetFullHelp() [][]key.Binding

func (Model) GetSave ¶

func (m Model) GetSave() ([]byte, error)

func (Model) Init ¶

func (m Model) Init() tea.Cmd

func (Model) IsSolved ¶

func (m Model) IsSolved() bool

func (Model) SetTitle ¶

func (m Model) SetTitle(t string) game.Gamer

func (Model) Update ¶

func (m Model) Update(msg tea.Msg) (game.Gamer, tea.Cmd)

func (Model) View ¶

func (m Model) View() string

type NonogramMode ¶

type NonogramMode struct {
	game.BaseMode
	Width, Height int
	Density       float64 // target fill percentage, 0.0–1.0
}

func NewMode ¶

func NewMode(title, description string, width, height int, density float64) NonogramMode

func (NonogramMode) Spawn ¶

func (n NonogramMode) Spawn() (game.Gamer, error)

type Save ¶

type Save struct {
	State    string               `json:"state"`
	Width    int                  `json:"width"`
	Height   int                  `json:"height"`
	RowHints TomographyDefinition `json:"row-hints"`
	ColHints TomographyDefinition `json:"col-hints"`
}

type TomographyDefinition ¶

type TomographyDefinition [][]int

func (TomographyDefinition) RequiredLen ¶

func (t TomographyDefinition) RequiredLen() int

func (TomographyDefinition) String ¶

func (t TomographyDefinition) String() string

Source Files ¶

View all Source files

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