=====================================================================
YASS - Yet Another Sokoban Solver and Optimizer - For Small Puzzles
Version 2.153 - November 17, 2024
Copyright (c) 2024 by Brian Damgaard, Denmark
=====================================================================

Sokoban(r) Registered Trademark of Falcon Co., Ltd., Japan
Sokoban Copyright (c) 1982-2024 by Hiroyuki Imabayashi, Japan
Sokoban Copyright (c) 1989, 1990, 2001-2024 by Falcon Co., Ltd., Japan

License
--------
YASS - Yet Another Sokoban Solver and Optimizer
Copyright (c) 2024 by Brian Damgaard, Denmark

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.

Credits and acknowledgments
---------------------------
Many people have contributed to this program, and I'm particularly
indebted to:

Lee J Haywood for providing most of the basic deadlock patterns,
for sharing a lot of ideas, and for a long-standing correspondence
on Sokoban topics.

Matthias Meger for sharing a lot of ideas and for a long-standing
correspondence on solvers, optimizers, and deadlock-detection.

Sebastien Gouezel for inventing the "Vicinity search" optimization
method, and generously sharing information on the method and its
implementation. By sharing his ideas and insights on the subject,
he has made a significant and lasting contribution to the Sokoban
game itself, transcending the implementation of the algorithm in
the YASS optimizer.

Features
--------
The program offers two independent features:
* Search for solutions of Sokoban puzzles.
* Search for improvements of existing solutions.

Solving and optimizing Sokoban puzzles are complicated tasks for a computer
program, so the program can only handle small puzzles.

In versions prior to version 2.149, the solver's backward search and forward
search methods could find push-optimal solutions for some small puzzles by
using A* search. Version 2.149 changed from A* search to greedy search. All
comments in the source code regarding push-optimality are obsolete but have
been left intact for nostalgic reasons.

YASS for Android
----------------
YASS for Android is a port. The official YASS website is located here:
https://sourceforge.net/projects/sokobanyasc/

The solver source code is in the file /app/src/main/jni-pascal/YASS.pas.
This file is (almost) identical to the original file from the official
YASC website. This enables quick updates when the official YASS version
updates.

Compiling the Program
---------------------
You need FreePascal 3.2 to build the native Pascal module. Make sure to
download the package containing the cross-compiler for Android.

The gradle build searches for the FreePascal compiler in the PATH
environment variable.