Extended logic puzzle solver of Noq.
-
@T0nyX1ang: backend, frontend, new solver implementations, bug fixes
-
@zhuyaoyu: (huge) solver optimizations, new solver implementations, bug fixes
-
Remove redundant codes and formatting codes.
-
New solver backend with new UI design (See issue #2)
-
Change the backend from Django to Starlette with Uvicorn (See issue #31, #50).
-
Change the frontend from Noq native to penpa-edit. (See issue #36).
-
Obtain uniform data structures in every puzzle. (See issue #88).
-
Deploy the entire solver to Github Pages with the help of
PyScript.
-
Select puzzle type.
-
Show rules in puzz.link if possible.
-
Choose example puzzle.
-
Show/Edit parameters of the solver if possible.
-
Solve/Reset the puzzle.
Note: if the puzzle is imported from puzz.link, you will need to change the edit mode to Problem to reset the puzzle itself.
-
Install uv first.
-
Clone this project and switch to
masterbranch.
git clone https://github.com/T0nyX1ang/noqx.git- Create a virtual environment (Optional):
uv venv- Install non-development packages with uv:
uv sync --extra web --no-dev- Run with uv:
uv run main.py- Install requirements (automatically generated by uv):
pip install -r requirements.txt- Clone this project and switch to
masterbranch.
git clone https://github.com/T0nyX1ang/noqx.git- Run locally (based on your system):
py -3 main.py
python3 main.py-
Download the latest release here.
-
A new version is released from weekly to monthly.
usage: main.py [-h] [-H HOST] [-p PORT] [-d] [-tl TIME_LIMIT] [-pt PARALLEL_THREADS] [-D]
usage: main.exe [-h] [-H HOST] [-p PORT] [-d] [-tl TIME_LIMIT] [-pt PARALLEL_THREADS] [-D]
optional arguments:
-h, --help show this help message and exit
-H HOST, --host HOST the host to run the server on.
-p PORT, --port PORT the port to run the server on.
-d, --debug whether to enable debug mode with auto-reloading.
-tl TIME_LIMIT, --time_limit TIME_LIMIT
time limit in seconds. (default = 30)
-pt PARALLEL_THREADS, --parallel_threads PARALLEL_THREADS
parallel threads. (default = 1)
-D, --enable_deployment
Deploy Pyscript for client-side purposes.
-
Install uv first.
-
Clone this project and switch to
devbranch.
git clone https://github.com/T0nyX1ang/noqx.git
git checkout dev- Install all dependencies with uv:
uv sync --all-extras- Install pre-commit and add commit hooks:
uv pre-commit install-
Create a python file in
solver/and write solver codes in that file. The functions innoqxpackage are free to use. -
Use the data structures from the puzzle. The atom element of a puzzle is a cell, and the data structures are all crafted around a cell. In detail, a puzzle has the following attributes:
puzzle_name: the name of the puzzle, should be the same as the filename of the solver.param: the parameters of the puzzle.row: the number of rows in the puzzle.col: the number of columns in the puzzle.margin: the margin of the puzzle, the order is a tuple of (top-margin,bottom-margin,left-margin,right-margin).surface: the shaded cells in the puzzle.text: the text clues in the puzzle.symbol: the symbols in the puzzle.edge: the borders in the puzzle.line: the lines in the puzzle.
-
Create a class inheriting the base class
noqx.manager.Solver. -
Implement a
solvefunction and write the ASP program needed. -
(Optional) Implement a
refinefunction if extra refinement is needed after program solving. -
(Optional) Set static values of the solver, where these values are:
name: the name of the solver.category: the category of the solver, should beshade(Shading),loop(Loop / Path),region(Area Division),num(Number),var(Variety),draw(Drawing),unk(Unknown).examples(Optional): a list of examples of the solver, each example can be created in two conflicting ways,dataandurl:data: directly draw the board in noqx and get the data URL by usingShare → Editing URL → Copy. The URL are suggested to be generated with the following conditions:- contains all the required
modesin this puzzle. - contains the required
sub-typesin this puzzle. - contains necessary initial conditions to pass the coverage tests.
- set
edit modetosolution modeinstead ofproblem mode.
- contains all the required
url: draw the board in puzz.link and useFile → Export URLto get the board URL.config(Optional): the configuration of the solver, which will be passed to the solver when it is created, and the keys ofconfigare the same asparameterskeys.test(Optional): whether the example is a test case, the default value isTrue, and cannot be used together withurlway.- Lots of examples can be found at pzplus.
parameters(Optional): the parameters of the solver, which will be passed to the solver when it is created.
-
Free to PR now ^_^
- Run the tests (with default
unittestfeatures) with uv:
uv run coverage run -m unittest- Check the HTML version of coverage report with uv:
uv run coverage html- This project is dual-licensed under Apache 2.0 and GPL 3.0 (or any later version). You can choose between one of them if you use this project.