sudoku

package

v1.0.0 Latest Latest Go to latest Published: Feb 9, 2026 License: MIT Imports: 11 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

Documentation ¶

Overview ¶

Package sudoku implements the classic number-placement puzzle.

Index ¶

Variables
func GenerateProvidedCells(m SudokuMode) []cell
func New(mode SudokuMode, provided []cell) (game.Gamer, error)
type KeyMap
type Model
- func ImportModel(data []byte) (*Model, error)
type Save
type SudokuMode
- func NewMode(title, description string, providedCount int) SudokuMode
- func (s SudokuMode) Spawn() (game.Gamer, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultKeyMap = KeyMap{
	CursorKeyMap: game.DefaultCursorKeyMap,
	FillValue: key.NewBinding(
		key.WithKeys("1", "2", "3", "4", "5", "6", "7", "8", "9"),
		key.WithHelp("[1-9]", "Fill Cell"),
	),
	ClearCell: key.NewBinding(
		key.WithKeys("backspace"),
		key.WithHelp("bkspc", "Clear Cell Contents"),
	),
}

View Source

var Modes = []list.Item{
	NewMode("Beginner", "45–52 clues. Single Candidate / Scanning.", 45),
	NewMode("Easy", "38–44 clues. Naked Singles.", 38),
	NewMode("Medium", "32–37 clues. Hidden Pairs / Pointing.", 32),
	NewMode("Hard", "27–31 clues. Box-Line Reduction / Triples.", 27),
	NewMode("Expert", "22–26 clues. X-Wing / Y-Wing.", 22),
	NewMode("Diabolical", "17–21 clues. Swordfish / XY-Chains.", 17),
}

Functions ¶

func GenerateProvidedCells ¶

func GenerateProvidedCells(m SudokuMode) []cell

GenerateProvidedCells generates a random sudoku puzzle with the number of provided cells determined by the mode's ProvidedCount.

func New ¶

func New(mode SudokuMode, provided []cell) (game.Gamer, error)

Types ¶

type KeyMap ¶

type KeyMap struct {
	game.CursorKeyMap
	FillValue key.Binding
	ClearCell 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

GetDebugInfo implements game.Gamer.

func (Model) GetFullHelp ¶

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

GetFullHelp implements game.Gamer.

func (Model) GetSave ¶

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

func (Model) Init ¶

func (m Model) Init() tea.Cmd

Init implements game.Gamer.

func (Model) IsProvidedCell ¶

func (m Model) IsProvidedCell() bool

func (Model) IsSolved ¶

func (m Model) IsSolved() bool

IsSolved implements game.Gamer.

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)

Update implements game.Gamer.

func (Model) View ¶

func (m Model) View() string

View implements game.Gamer.

type Save ¶

type Save struct {
	Solved   bool         `json:"solved"`
	Grid     string       `json:"grid"`
	Provided []exportCell `json:"provided"`
}

type SudokuMode ¶

type SudokuMode struct {
	game.BaseMode
	ProvidedCount int
}

func NewMode ¶

func NewMode(title, description string, providedCount int) SudokuMode

func (SudokuMode) Spawn ¶

func (s SudokuMode) Spawn() (game.Gamer, error)

Source Files ¶

View all Source files

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