path: root/README

           ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                 FORNAX
             Collection of tools to visualize Path Finding
                               Algorithms

                                Andinus
           ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


Table of Contents
─────────────────

1. Demo
2. Documentation
3. Project Structure
4. Fornax Format
.. 1. Grids
5. News
.. 1. v0.1.0 - 2021-11-03


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 Website          <https://andinus.unfla.me/projects/fornax>
 Source           <https://git.unfla.me/fornax>
 GitHub (mirror)  <https://github.com/andinus/fornax>
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

This collection includes:
• `fornax': Program that parses /Fornax Format/ and outputs video
  solution.
• Algorithms: Various algorithms solved in several programming
  languages.


1 Demo
══════

  Solution for /DFS-33/, generated on /2021-11-03/ (click to play).

  [https://andinus.unfla.me/resources/projects/fornax/2021-11-03-DFS-33.png]


[https://andinus.unfla.me/resources/projects/fornax/2021-11-03-DFS-33.png]
<https://andinus.unfla.me/resources/projects/fornax/2021-11-03-DFS-33.mp4>


2 Documentation
═══════════════

  Fornax parses /Fornax format/, generates a `PNG' for each iteration
  which is later converted to a slideshow with `ffmpeg'.

  • Solved paths are highlighted if the iteration is preceded by `|'.
  • Illegal paths are highlighted if the iteration is preceded by `!'.

  • *Note*: If the number of iterations are greater than an 8 digit
    number then the slideshow might be incorrect.


3 Project Structure
═══════════════════

  • Algorithms are located in `algorithms/' directory, sub-directory
    needs to be created for programming languages which will hold the
    actual source.

  • Sample solutions can be found in `resources/solutions/' directory.

    • *Note*: Some solutions might output illegal moves (like walking
      over blocked path), this error is only in visualization, the
      solution is correct.

      This has been fixed in commit
      `8cef86f0eb8b46b0ed2d7c37fa216890300249f6'.


4 Fornax Format
═══════════════

  Fornax format is an intermediate output file generated after solving
  the maze. Algorithms must output the solution in this format.

  ┌────
  │ rows:<number of rows> cols:<number of columns>
  │
  │ ...iterations
  └────

  `...iterations' is to be replaced by the resulting grid in each
  iteration that is to be included in the final video. Since the number
  of rows and columns is known, the whole grid should be printed in a
  single line.

  • Every iteration should be separated by a newline.

  • If the iteration cells is not equal to `rows * columns' or `(rows *
      columns) + 1' then it may be ignored by the program that parses
      the file.

  • Solved iteration can be preceded by `|' character.

  • Iteration that tries to walk on a blocked path can be preceded by
    `!' character.

  • First iteration is assumed to be the maze.


4.1 Grids
─────────

  A grid is printed for every iteration. Grids are composed of cells.

  ━━━━━━━━━━━━━━━━━━━━━━━━━━
   Cell              Symbol
  ──────────────────────────
   Path              `.'
   Blocked           `#'
   Destination       `$'
  ──────────────────────────
   Visited           `-'
   Current Position  `@'
  ━━━━━━━━━━━━━━━━━━━━━━━━━━

  • /Current Position/ is prioritized over /Blocked/ & /Destination/
    symbol if it makes sense.


5 News
══════

5.1 v0.1.0 - 2021-11-03
───────────────────────

  ⁃ Initial implementation. Includes DFS solver in Java, tool to
    visualize the solution.