KYUJO FOR WINDOWS - SETUP
======================================================================

This builds Kyujo on YOUR computer from the open-source decompilation of the game and your own copy of it. Nothing in this kit is a game
program, and nothing in it was taken from a game file.

YOU NEED: the North American (USA) version 1.0 of the game as a ROM file (.z64, .n64 or .v64), Windows 10 or 11, about 1 GB of free space, and the internet (once).

HOW
  1. Unzip this folder to a SHORT path, for example C:\Kyujo (not deep inside Downloads or OneDrive: Windows limits path length).
  2. Double-click Setup.bat. Choose your ROM file when asked. (Or drag the ROM file onto Setup.bat.)
  3. Wait a few minutes and don't close the window. When it says Done, start 'Play Kyujo' from this folder.

PLAYING: F1 or Esc opens the in-game menu (settings, controllers, saves, Game Boy cartridges).
  Keys: arrows = stick, X or Space = A, Z or Backspace = B, C = Z, Enter = START, Q/E = L/R, W A S D = D-pad, I J K L = C buttons. Gamepads work too.

PROBLEMS: if a message says SETUP STOPPED, it says what to fix; run Setup.bat again afterwards and it continues where it can.
  To report one, open an issue at the project's page and attach work\logs\setup.log and work\logs\build.log (they contain no game data).

WHAT THE SETUP DOES
  - checks that your ROM is the supported one (it is read, never modified, never copied unless it needs a byte-order conversion);
  - downloads the compiler package llvm-mingw-20240619-ucrt-x86_64.zip (about 142 MB) from github.com and checks its SHA-256 before using it;
  - downloads the game's source code (about 43 MB, commit 8efced606b) from https://github.com/team-hippodrome/pokestadium;
  - checks every source file against app\port\decomp-manifest.txt (SHA-256) and stops if one differs;
  - builds Game\kyujo.exe, checks it, writes Game\kyujo.cfg with your ROM, and makes a shortcut.
  It writes only inside this folder, installs nothing, and needs no administrator rights. To remove everything, delete the folder.

SIZE: about 0.6 GB while building (work\ can be deleted afterwards; the next Setup run then unpacks and builds again).
SmartScreen or antivirus may comment on the new kyujo.exe: it is a program nobody has signed. It is built from the open sources named above.

NEEDS THE INTERNET only for the downloads above (github.com). To prepare an offline run, put the files into downloads\ yourself:
  llvm-mingw-20240619-ucrt-x86_64.zip   from https://github.com/mstorsjo/llvm-mingw/releases/download/20240619/llvm-mingw-20240619-ucrt-x86_64.zip
  pokestadium-8efced606b389f8ff2793ad52beddf60aba213ab.zip   from <source>/archive/8efced606b389f8ff2793ad52beddf60aba213ab.zip

LICENCES: this port's own code is GPL-3.0-only (app\LICENSE). That does not cover the game or the decompilation, which have their own
owners and no stated licence; for that reason the exe you build is for your own use and must not be shared (app\NOTICE.md explains).
The other components and their licences are listed in app\THIRD-PARTY.md; the compiler package carries its own licence texts
inside its zip (LLVM: Apache-2.0 with LLVM exception; mingw-w64; Python: PSF).
