README
¶
macondo
A crossword board game solver. It may be the best one in the world (so far).
Current master build status:
What is a crossword board game?
A crossword board game is a board game where you take turns creating crosswords with one or more players. Some examples are:
- Scrabble™️ Brand Crossword Game
- Words with Friends
- Lexulous
- Yahoo! Literati (defunct)
How to use Macondo:
See the manual and information here:
https://domino14.github.io/macondo
protoc
To generate pb files, run this in the macondo directory:
go generate
Make sure you have done
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
Creating a new release
(Notes mostly for myself)
Tag the release; i.e. git tag vX.Y.Z, then git push --tags. This will kick off a github action that builds and uploads the latest binaries. Then you should generate some release notes manually.
Using Triton
If you want to use the neural network model, I recommend you use Triton server rather than the default Go server. It's much faster, but it's not trivial to run locally.
If your macondo directory is at $HOME/code/macondo you would run docker run with these parameters:
docker run --gpus all --rm -p 8000:8000 -p 8001:8001 -p 8002:8002 -v $HOME/code/macondo/data/strategy/default/models/:/models nvcr.io/nvidia/tritonserver:25.06-py3 tritonserver --model-repository=/models
You may need to install the NVIDIA Container Toolkit to use your GPU for inference.
Then you can run Macondo with the MACONDO_TRITON_USE_TRITON environment variable set to true.
Attributions
Wolges-awsm is Copyright (C) 2020-2022 Andy Kurnia and released under the MIT license. It can be found at https://github.com/andy-k/wolges-awsm/. Macondo interfaces with it as a server.
KLV and KWG are Andy Kurnia's leave and word graph formats. They are small and fast! See more info at https://github.com/andy-k/wolges
Some of the code for the endgame solver was influenced by the MIT-licensed Chess solver Blunder. See code at https://github.com/algerbrex/blunder
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
ai
|
|
|
Package automatic contains all the logic for the actual gameplay of Crossword Game, which, as we said before, features all sorts of things like wingos and blonks.
|
Package automatic contains all the logic for the actual gameplay of Crossword Game, which, as we said before, features all sorts of things like wingos and blonks. |
|
cmd
|
|
|
analyzer-worker
command
|
|
|
bot
command
|
|
|
bot_shell
command
|
|
|
eval
command
|
|
|
inferdiag
command
inferdiag — Tier 1 + Tier 2 Bayesian inference diagnostic harness.
|
inferdiag — Tier 1 + Tier 2 Bayesian inference diagnostic harness. |
|
lambda
command
|
|
|
make_wmp
command
make_wmp builds a .wmp file from a .kwg file.
|
make_wmp builds a .wmp file from a .kwg file. |
|
mlproducer
command
|
|
|
shadow_test
command
shadow_test is a command-line tool that runs shadow agreement tests.
|
shadow_test is a command-line tool that runs shadow agreement tests. |
|
shell
command
|
|
|
updater
command
|
|
|
wmp_test
command
wmp_test is a command-line tool that runs WMP agreement tests.
|
wmp_test is a command-line tool that runs WMP agreement tests. |
|
example
command
|
|
|
Package game encapsulates the main mechanics for a Crossword Game.
|
Package game encapsulates the main mechanics for a Crossword Game. |
|
Package gcgio implements a GCG parser.
|
Package gcgio implements a GCG parser. |
|
gen
|
|
|
Package leavemap provides an O(1) leave-value lookup table indexed by a per-tile bitmask.
|
Package leavemap provides an O(1) leave-value lookup table indexed by a per-tile bitmask. |
|
Package montecarlo implements truncated monte-carlo search during the regular game.
|
Package montecarlo implements truncated monte-carlo search during the regular game. |
|
Package movegen contains all the move-generating functions.
|
Package movegen contains all the move-generating functions. |
|
wordprune
Package wordprune implements a pruned KWG (word graph) for endgame solving.
|
Package wordprune implements a pruned KWG (word graph) for endgame solving. |
|
trickle.go – reads 1 KiB per second
|
trickle.go – reads 1 KiB per second |
|
Package wmp implements WordMap, a fast anagram-lookup data structure for crossword move generation.
|
Package wmp implements WordMap, a fast anagram-lookup data structure for crossword move generation. |