path: root/README

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

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


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

1. Documentation
2. Fornax Format
.. 1. Grids
3. Project Structure


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 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 Documentation
═══════════════

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


2 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:<number of iterations>
  │
  │ ...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 must be preceded by `|' character. The program may
    or may not use it while rendering the video.


2.1 Grids
─────────

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

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


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

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