Verdite1
========

King's Field (Japan, 1994) for Windows and Linux, in English with the fan translation
or in the original Japanese, plus optional widescreen, high frame rates,
lighting, an automap, quick saves, a settings overlay and Lua mods.

Project page, updates and bug reports:
  https://github.com/Voicedrew11/verdite1

Please attach the crash report, if there is one, or kf.log (see below) to bug
reports.


WHAT YOU NEED
-------------
A disc image of King's Field (Japan) SLPS-00017 that you dumped yourself:
  - the original Japanese disc (the game offers to add the English translation
    by downloading the translator's own patch), or
  - a disc with the English translation patch (v1.0, by John Osborne) applied:
    https://www.romhacking.net/translations/7308/
Use a .cue + .bin pair (single track), an .iso or a .chd. No game files are
included.


UPDATES
-------
The game tells you on the title screen when a new version is out, and opens its
download page if you ask. Nothing is downloaded by itself. It asks GitHub at most
once an hour; turn that off in F1 > Settings > Interface. To update, run the new
installer, or replace the .AppImage or the unpacked folder. Your saves stay.


FIRST LAUNCH
------------
Put your disc image (.cue + .bin, .iso or .chd) in the same folder as the game
(verdite1.exe, or the .AppImage on Linux) and start it, or start it and
choose the image when asked. The game copies its files into a "data" folder
there, once (into the user folder below if the game's folder is read-only).
An installed copy keeps it in its install folder, by default
%LOCALAPPDATA%\Programs\Verdite1. The AppImage keeps it in the user folder
below, and moves a "data" folder from beside it there.
The image itself is not changed. On Windows you can also drop the .cue onto
verdite1.exe. On Linux, make the .AppImage executable first.

To switch to a different image later, delete the "data" folder.


LANGUAGES
---------
English and Japanese can be switched at any time: in the game's Options menu
(Language row) or in F1 > Settings > Language. Saves work in both.
- English from a Japanese disc: the game downloads the translator's original
  patch (Kings_Field_Jap_to_Eng_v1.0.rar, about 6 MB) from the Internet
  Archive, or uses that file if you choose it or drop it onto verdite1.exe.
- Japanese with a patched disc: add your original Japanese disc image in
  F1 > Settings > Language, or drop it onto verdite1.exe.


CONTROLS
--------
  Move / strafe ........ W A S D
  Look ................. Mouse (click the window first), Page Up / Page Down
  Turn ................. Left / Right arrows
  Run .................. Shift
  Attack ............... Space, left mouse button
  Magic ................ Q, right mouse button
  Interact / confirm ... F, Enter
  Menu ................. Tab (Tab or Backspace backs out)
  Pause ................ P, Escape
  Full map ............. M
  Quick save / load .... F2 / F4 (F4 also works on the title screen)
  Settings overlay ..... F1
  Fullscreen ........... F11, Alt+Enter

Every enhancement can be switched off in the F1 settings, or all at once with
Classic mode at the top of F1 > Settings (your own settings come back when you
turn it off).


FILES
-----
Saves, settings, mods and kf.log are in:
  Windows: %APPDATA%\Verdite\Verdite1
  Linux:   ~/.local/share/Verdite/Verdite1
If the game crashes or stops responding it says so, and saves a report in the
"crashes" folder there (the newest 20 are kept). Each report's folder holds
report.txt, kf.log and copies of your saves, so send the whole folder.
If you played King's Field Enhanced, its folder (KingsField\SLPS00017 beside
it) is copied there on the first launch, and left as it was.
Saves are BISLPS-00017KF, the PlayStation's own save file (the quick save is
BISLPS-00017KF.quick). Saves from King's Field Enhanced are brought in on the
first launch.
The example mods in the "mods" folder here are copied there on the first launch,
switched off. Enable them in F1 > Mods. See MODDING.md for writing your own.


CREDITS
-------
Built on sushi-shi's King's Field source port (CC0):
  https://github.com/sushi-shi/kings-field-decomp
Starting from acranon's King's Field Enhanced:
  https://github.com/acranon/kf1-enhanced
English translation by John Osborne (weissvulf / HwitVlf); it is applied to
your own disc, not included.
Uses Dear ImGui, Lua, cJSON, SDL3, libchdr and zstd; their licenses are in
the "licenses" folder.

King's Field is by FromSoftware. This is an unofficial fan project, not
affiliated with or endorsed by FromSoftware or Sony.
