dholmes215 / grandrounds

Nonogram tour of Minneapolis' Grand Rounds Scenic Byway

grandrounds

About

This is a nonogram tour of Minneapolis' Grand Rounds Scenic Byway, a submission for Jason's C++ Best Practices Game Jam. At least, that's what it's supposed to be, except time constraints mean it shows very little of the Grand Rounds at the moment.

How To Play

To learn how to play nonograms in general, see: [https://www.youtube.com/watch?v=zisu0Qf4TAI&list=PLH_elo2OIwaAYMF8CAfDnlKcVyyB5UITk]

To play this implementation of the game specifically: click with the left mouse button to fill a cell (color it black). Click with the right button to clear a cell (color it white). Click with the middle button to "mark" a cell. Keyboard controls are presently not supported.

Requirements

The puzzles are not included in the binary release packages, so if you don't build from source, they must be downloaded from the source release, or from the git repository itself. The "puzzles" directory must be in either the working directory or some ancestor of the working directory.

You'll need a terminal with mouse support, ideally 24-bit color support, and at least enough font support to display a "▄" character. I've only tested on Windows, with Windows Terminal, which should work out of the box.

Bugs

The terminal scrolls a line occasionally, and when it does, the mouse no longer selects the correct line until you scroll it back. I haven't looked into why.

More Details

• Dependency Setup
• Building Details
• Troubleshooting
• Docker

grandrounds's Issues

CodeQL is failing

The CodeQL GitHub action presently hangs indefinitely until it times out. I have no idea why.

Implement more unit tests

Right now I only have one real unit test. I should have more.

Fix & test terminal scrolling & size bugs

When switching between screens, the Windows terminal seems to scroll up a line, and the mouse coordinates no longer match up with the component coordinates unless it's scrolled back into place. This seems to have started happening when I switched to different event loop calls for different screens.

There also seem to be some problems with resizing the terminal while the game is running.

Puzzles folder needs to be included in release packages

Presently the puzzles folder is missing from all the binary packages, and needs to be manually downloaded and put in the right place. It should be included in the packages.

vcpkg needs to chainload toolchains in CI

The vcpkg branch contains an attempt to build and consume dependencies using vcpkg, which is presently not using the compiler choices appropriate for the running CI build - in particular the Windows LLVM builds are building libraries using MSVC instead of clang. In the case of FTXUI this is causing a build failure as it passes the MSVC flag /utf-8 into clang, but even if the build didn't fail, vcpkg still needs to use clang to build libraries for clang builds.

See https://github.com/dholmes215/grandrounds/runs/6120978770?check_suite_focus=true

Get code coverage reporting set up

Code is bad

Make it good.

Add WASM support

Several other gamejam entries have WASM versions. Figure out how they did it and do the same. Ideally there should also be WASM CI builds. It sounds like the current Conan usage might be an issue.