CSharperMantle / mazer

Assignment 2.2 for HDU 2023 fall course Preliminary Program Designing and Algorithms

mazer

Assignment 2.2 for HDU 2023 fall course Preliminary Program Designing and Algorithms.

Solve any 20-by-20 maze interactively.

How to play?

The build system is based on xmake. Also, you need a ncurses-compatible OS environment to successfully compile and run.

git clone --depth 1 -- https://github.com/CSharperMantle/mazer.git
cd mazer
xmake
xmake run

See https://github.com/CSharperMantle/mazer_win if you need a Windows fork.

On entering game, you will be prompted to make edits to an preloaded maze map. This mode is named "EDIT mode". The following controls are available:

• q: Quit "EDIT mode"
• h, j, k, l: Move the cursor left/down/up/right
• Space: Switch cell under cursor between "wall" and "path" (not wall)
• s, e: Move starting/ending point (terminals, terms) to cursor

Here is a example screen under EDIT mode: (legends: #: wall; S: starting point; E: ending point)

┌──────────────────────┐  ┌──────────────────────┐
│                      │  │                      │
│ #################### │  │                      │
│ #S#               ## │  │                      │
│ # ###### # ###### ## │  │                      │
│ #        #        ## │  │                      │
│ ######## ######## ## │  │                      │
│ #      #        # ## │  │                      │
│ # #### # ###### # ## │  │                      │
│ # #    # # #    # ## │  │                      │
│ # ###### # ###### ## │  │                      │
│ #        #        ## │  │                      │
│ ################# ## │  │                      │
│ #      #        # ## │  │                      │
│ # #### # ###### # ## │  │                      │
│ # #    # # #    # ## │  │                      │
│ # ###### # ###### ## │  │                      │
│ #                 ## │  │                      │
│ # ################## │  │                      │
│ #                  # │  │                      │
│ # ######## #######E# │  │                      │
│ #################### │  │                      │
│                      │  │                      │
└──────────────────────┘  └──────────────────────┘

┌────────────────────────────────────────────────┐
│ EDIT: q=run; hjkl=move; Spc=cycle; se=terms    │
└────────────────────────────────────────────────┘

After finishing your edits, press q as described above to enter "RUN mode". In RUN mode, any key press will advance the searching step by 1.

Here is a example screen under EDIT mode:

Here is a screenshot of RUN mode: (legends: #: wall; @: current location; .: visited path; S: starting point; E: ending point)

┌──────────────────────┐  ┌──────────────────────┐
│                      │  │                      │
│ #################### │  │ PROGESS (10,7)       │
│ #S#     ..........## │  │ BTRACK (10,8)        │
│ #.######.#.######.## │  │ BTRACK (10,9)        │
│ #........#........## │  │ BTRACK (11,9)        │
│ ########.########.## │  │ BTRACK (12,9)        │
│ #......#........#.## │  │ BTRACK (13,9)        │
│ #.####.#.######.#.## │  │ BTRACK (14,9)        │
│ #.#....#.#.#....#.## │  │ BTRACK (15,9)        │
│ #.######.#.######.## │  │ BTRACK (16,9)        │
│ #........#........## │  │ BTRACK (17,9)        │
│ #################.## │  │ PROGESS (17,10)      │
│ #      #        #.## │  │ PROGESS (17,11)      │
│ # #### # ###### #.## │  │ PROGESS (17,12)      │
│ # #    # # #    #.## │  │ PROGESS (17,13)      │
│ # ###### # ######.## │  │ PROGESS (17,14)      │
│ #            @....## │  │ PROGESS (17,15)      │
│ # ################## │  │ PROGESS (16,15)      │
│ #                  # │  │ PROGESS (15,15)      │
│ # ######## #######E# │  │ PROGESS (14,15)      │
│ #################### │  │ PROGESS (13,15)      │
│                      │  │                      │
└──────────────────────┘  └──────────────────────┘

┌────────────────────────────────────────────────┐
│ RUN: Ctrl-C - quit, others - step              │
└────────────────────────────────────────────────┘

On the right you can inspect the algorithm progress. You can exit the program by entering combo Ctrl-C.

Once one maze search completes, whether it succeeds or fails, you will be prompted with EDIT mode again, retaining all changes you have made in previous edits.

Third-party libraries

• ncurses: terminal I/O library

License

BSD 3-Clause License

Copyright (c) 2023, Rong "Mantle" Bao <[e-mail]>

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.