crossregex-typ

A crossword-like game written in Typst. You should fill in letters to satisfy regular expression constraints. Currently, squares and regular hexagons are supported.

Note

This is not a puzzle solver, but a puzzle layout builder.

It takes inspiration from a web image, which derives our standard example. I'm not the original author.

Examples

Code can be found in ./examples

Sudoku

Derives from https://regexcrossword.com/playerpuzzles/65bbe21e88914.

Mini hex

Standard hex

Appearance

Cells

The cells can be customized. For squares, the default is

#polygon.regular(size: calc.sqrt(2) * 1em, vertices: 4, stroke: 0.5pt)

For hexagons, the default is

#rotate(30deg, polygon.regular(size: 2em, vertices: 6, stroke: 0.5pt), origin: center)

Constraint hints

In front of each regex constraint text, we have a circle in red, yellow or green. It has the following meaning:

• $\color{red}\text{Red}$: This constraint is not satisfied.
• $\color{yellow}\text{Yellow}$: This constraint is satisfied, but unfilled cells exist.
• $\color{green}\text{Green}$: This constraint is satisfied.

You can change this default behavior by passing a custom deco-config.hint-marker.

The regex box can also be customized by the deco-config.regex-style function. The default function is

#box.with(fill: gray.transparentize(90%), outset: (x: 0.1em, y: 0.2em), radius: 0.2em)

We use a wasm plugin to check regex matching, which employs the fancy-regex crate to bring more features than regex used by Typst provided. You can refer to its doc to learn about supported syntax. Note that \d is not supported. Please use [0-9] directly instead.

Filled letters

In the grids, upper-case letters are colored $\color{blue}\text{blue}$, while others are colored $\color{purple}\text{purple}$. So you can use lower-case letters or symbols as hints.

This default behavior can also be changed by a custom cell-config.

Counting

If you provide answers, it will show the number of filled and total cells at bottom left.

You can provide a custom creator function progress-creator, whose default is

#(filled, total) => text(orange)[#filled/#total]

You can turn of the progress by a none value.

Basic Usage

We use crossregex-square and crossregex-hex to build square and hex layouts respectively. They have the same argument formats. A crossregex dispatcher function can be used for dynamic grid kind, which is compatible with version 0.1.0.

#import "@preview/crossregex:0.2.0": crossregex
// or import and use `crossregex-hex`

#crossregex(
  3,
  constraints: (
    `A.*`, `B.*`, `C.*`, `D.*`, `E.*`,
    `F.*`, `G.*`, `H.*`, `I.*`, `J.*`,
    `K.*`, `L.*`, `M.*`, `N.*`, `O.*`,
  ),
  answer: (
    "ABC",
    "DEFG",
    "HIJKL",
    "MNOP",
    "QRS",
  ),
)

#import "@preview/crossregex:0.2.0": crossregex-square

#crossregex-square(
  9,
  alphabet: regex("[0-9]"),
  constraints: (
    `.*`,
    `.*`,
    `.*`,
    `.*`,
    `.*[12]{2}8`,
    `[1-9]9.*`,
    `.*`,
    `.*`,
    `.*`,
    `[1-9]7[29]{2}8.6.*`,
    `.*2[^3]{2}1.`,
    `.9.315[^6]+`,
    `.+4[15]{2}79.`,
    `[75]{2}18.63[1-9]+`,
    `8.*[^2][^3][^1]+56[^6]`,
    `[^5-6][0-9][56]{2}.*9`,
    `.*`,
    `[98]{2}5.*[27]{2}6`,
  ),
  answer: (
    "934872651",
    "812456937",
    "576913482",
    "125784369",
    "467395128",
    "398261574",
    "241537896",
    "783649215",
    "659128743",
  ),
  cell: rect(width: 1.4em, height: 1.4em, radius: 0.1em, stroke: 1pt + orange, fill: orange.transparentize(80%)),
  cell-config: (size: 1.6em, text-style: (size: 1.4em)),
)

Document

Details are shown in the doc comments above the crossregex function in lib.typ. You can choose to turn off some views.

Feel free to open issues if any problems.

Changelog

0.2.0

• Feature: Supports square shapes.
• Feature: Supports customization the appearance of everything, even the cells.
• Feature: Supports custom alphabets.
• Fix: An mistake related to import in the README example.

0.1.0

First release with basic hex features.