Puzzle library

The puzzle library is the database of all known puzzle definitions. The global variable puzzles contains the global puzzle library.

Methods

puzzles:add()

puzzles:add() adds a puzzle to the global puzzle library. It takes one argument: a table containing the following keys:

• id is a string containing a unique ID for the puzzle
• version is a string containing the semantic version for the puzzle
• name is a string containing a user-facing name for the puzzle
• tags is a table containing a tag specification.
• colors is a string containing the ID of a color system in the color system library
• ndim is the number of dimensions for the puzzle
• build is a function used to construct the puzzle

The keys id, version, ndim and build are required. All other keys are optional. The keys name, tags, and colors are recommended.

The puzzle is not constructed immediately when puzzles:add() is called. (Otherwise, the program would slow to a crawl loading all the puzzles on startup.) Instead, only the ID, name, tags, and other metadata is stored.

When the user first opens a puzzle, a puzzle object is initialized with a new ndim-dimensional space, and an empty color system, axis system, and twist system; build is then called with that puzzle as its argument. build is responsible for cutting the pieces and defining colors, axes, and twists. See Puzzle, Colors, Axes, and Twists for more.

Operations

• #puzzles returns the number of puzzles that have been loaded
• type(puzzles) returns 'puzzledb'