Short:        Jedi Knight II: Jedi Outcast for PiStorm3D
Author:       Raven Software, Amiga port by Serkan Dursun
Uploader:     Serkan Dursun <blasterreal gmail com>
Type:         game/shoot
Version:      1.0b1
Requires:     PiStorm (Pi4/CM4, Emu68), minigl.library 29.1, RTG, AHI
Architecture: m68k-amigaos >= 3.2.0
Distribution: Aminet
URL:          https://github.com/Sdursun/JediOutcast_Minigl

Star Wars Jedi Knight II: Jedi Outcast for AmigaOS / MiniGL
===========================================================
Version 1.0 beta 1

A port of Raven Software's Jedi Outcast single player source code to
AmigaOS 3.x on PiStorm (Emu68) with PiStorm3D hardware 3D (minigl.library).
The game runs natively as an m68k AmigaOS program.

This is a beta. The whole first level and its cutscenes are playable,
but expect bugs (see "Known issues").


Requirements
------------
- PiStorm with a Raspberry Pi 4 / CM4 running Emu68
- AmigaOS 3.2 (developed and tested on 3.2.3)
- RTG graphics (Picasso96) with a 16 bit screen mode
- minigl.library 29.1 or newer (PiStorm3D 29.1) in LIBS:
  Programs built for 29.1 do NOT start with the 29.0 library, and
  they fail without a message, so update the library first.
- AHI for sound
- Plenty of Fast RAM (the game uses well over 100 MB)
- The game data from the PC version of Jedi Outcast (GOG or Steam)


Installation
------------
1. Unpack the archive anywhere, e.g. to Games:
   This creates the drawer JediOutcast_Minigl.

2. Copy the game data from your PC installation of Jedi Outcast into the
   drawer JediOutcast_Minigl/base. You need these files from the PC game's
   GameData/base folder:

       assets0.pk3
       assets1.pk3
       assets2.pk3
       assets5.pk3   (from the 1.04 patch, the GOG and Steam versions have it)

   Afterwards the drawer looks like this:

       JediOutcast_Minigl/
           jk2sp            the game
           jk2sp.info
           ReadMe.txt
           LICENSE.txt      GNU General Public License
           base/
               amiga.cfg     Amiga settings
               autoexec.cfg  loads amiga.cfg at every start
               assets0.pk3   <- your game data
               assets1.pk3   <- your game data
               assets2.pk3   <- your game data
               assets5.pk3   <- your game data

   The game data is NOT included in this archive. You need your own copy
   of Jedi Outcast.

3. Start the game by double clicking the jk2sp icon, or from a Shell:

       cd Games:JediOutcast_Minigl
       jk2sp

   The icon sets a stack of 200000 bytes. From a Shell the game sets up
   its own stack.


Settings
--------
base/amiga.cfg holds the recommended settings and is loaded at every
start through base/autoexec.cfg. Settings can also be changed in the
console (Shift + the key left of 1) or given on the command line, e.g.

    jk2sp +set r_amigabright 1

r_amigabright 0/1/2   brightness of the level lighting (default 2).
                      The PC version brightens the picture through the
                      graphics card's gamma, which the Amiga does not have.
                      Takes effect when the level is loaded again.
r_picmip 0/1/2        texture detail: 0 full, 1 half (default), 2 quarter
r_mode 3              640x480, the fastest mode
F8                    screenshot into base/screenshots (Amiga keyboards
                      have no F12; F9-F12 are save and load)


Known issues
------------
- Sound can crackle.
- Loading a level takes a while (much faster than in the first tests).
- Quitting with Ctrl-C can crash the machine. Quit through the menu.
- After an error message the machine can hang instead of returning to
  the menu.
- The F8 screenshot key does not work yet. The console command
  "screenshot" does.
- Only the first levels have been tested.


Reporting problems
------------------
Start the game from a Shell with

    jk2sp -synclog

It writes jk2sync.log into the game drawer. Please attach this file to
bug reports at

    https://github.com/Sdursun/JediOutcast_Minigl/issues


Source code and license
-----------------------
The complete source code of this program, including all changes for
AmigaOS, is at https://github.com/Sdursun/JediOutcast_Minigl

Jedi Outcast source code copyright (C) 2002 Activision / Raven Software,
released under the GNU General Public License version 2. This port is
distributed under the same license, see LICENSE.txt. It comes with
ABSOLUTELY NO WARRANTY.

The AmigaOS changes (2026, Serkan Dursun) are in the source drawer
code/amigaos and, in the original files, inside "#ifdef __amigaos__"
blocks.

Parts not covered by the GPL, under their own licenses:
- This software is based in part on the work of the Independent JPEG
  Group (JPEG library, copyright (C) 1991-1995 Thomas G. Lane).
- zlib, copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler.
- stb_sprintf by Sean Barrett and Jeff Roberts (public domain / MIT).

Star Wars, Jedi Knight and Jedi Outcast are trademarks of Lucasfilm Ltd.
This port is not affiliated with or endorsed by Lucasfilm, LucasArts,
Disney, Activision or Raven Software. The game data is not included and
remains the property of its owners.


Credits
-------
- Raven Software for releasing the source code
- Dennis Boon (PiStorm3D) and Steffen "MagicSN" Haeuser (minigl.library)
- Michal Schulz (Emu68) and Claude Schwarz (PiStorm)
- Stefan "bebbo" Franke for the m68k-amigaos GCC toolchain
- Port by Serkan Dursun