﻿StarFox Remake [recompiled] — SpaceAnimalsRecomp 1.0.3
=====================================================================

Native PC port of Star Fox (Nintendo Switch 2) by static recompilation, created by SerenityG4K.
https://github.com/SerenityG4K/SpaceAnimalsRecomp

This package contains NO game files. It recompiles the game on your PC, from your own copy.

EXPERIMENTAL PROJECT: we are at the "it runs" stage. The game can be finished and is fairly stable, but it has only
been tested on a strong PC (AMD Ryzen 7 9700X, NVIDIA GeForce RTX 5070 Ti): we do not know yet how it runs elsewhere.
Report bugs on GitHub with your processor and graphics card.

You need:
  - Windows 10 or 11, 64-bit, a processor with AVX2, a Vulkan 1.3 graphics card (up-to-date driver);
  - 32 GB of RAM recommended; before playing, close heavy programs and let Windows manage the page file size
    (its default setting);
  - your copy of Star Fox (Nintendo Switch 2) in .nup format, with update 2.0.0 (v131072);
  - about 6 GB free during the build;
  - a folder whose path only has Latin characters (for example C:\Games\StarFox): the compiler does not handle
    others. Spaces are accepted: in that case the compiler is copied once to C:\ProgramData\StarFoxRecomp
    (about 600 MB).

Steps:
  1. Unzip this folder wherever you like (not in Program Files).
  2. Run lanceur.exe (the launcher; EN at the top right switches it to English).
  3. Choose your copy (COPY › choose), then click "RECOMPILE THE GAME".
     Allow 20 to 45 minutes depending on your processor: the launcher stays usable meanwhile.
  4. Near the end, all the game's shaders are compiled for your graphics card (about a minute): no more
     compilation stutter in game. The game also runs for a few seconds in the background, with no window and no
     sound, to collect the shaders it creates at startup. Nothing opens by itself during the build.
  5. Click "PLAY". Under the button: fullscreen or windowed. Settings: game language, resolution, frames per
     second, volume, rumble, updates. Controls: the keyboard keys can be changed (click a key, then press the one
     you want), with two presets, WASD (QWERTY keyboard) and ZQSD (AZERTY keyboard).

Updates: at startup the launcher checks the project's releases on GitHub (can be turned off in Settings) and asks
before installing one. A click on "UPDATE … AVAILABLE" downloads the new version, checks its SHA-256 hash, installs it
and restarts the launcher. Your compiled game is kept. Some improvements require rebuilding the game: the launcher
then offers it ("REBUILD NOW", only the steps whose code changed are redone). If you decline, you keep playing with
the current game.

Saves: %APPDATA%\SpaceAnimalsRecomp\save. A backup is made before each build and each update, in
%APPDATA%\SpaceAnimalsRecomp\save_backups (the last 10 are kept).

Logs (in English): recomp\build\full\preparation.log (build), recomp\build\full\recomp_run.log (game),
recomp\build\full\precompile.log (shaders), lanceur.log (launcher), mise_a_jour.log (updates).
"BUG REPORT" in the launcher gathers them in SpaceAnimalsRecomp-bug-report.zip, with your user name and folder
names removed: attach that file to your GitHub issue.

Memory: since version 1.0.3 the game takes its memory as needed, removes from RAM the texture data already sent
to the graphics card (kept in a temporary file of a few GB in the Windows temp folder, deleted when the game closes)
and prepares its shaders at first use. If the game misbehaves since then (missing images, stops), turn these savings
off in recomp\build\full\recomp.ini: texture_release = false, shaders_on_demand = false, zero_page_release = false
(empty pages of game memory given back to Windows), cold_page_release = false (forgotten pages put in the
temporary file), or memory_saver = false to put everything back as in version 1.0.2 (the game then takes more
memory).

Updates: the launcher asks before installing one, and you can decline. Once an update is installed, it offers to
rebuild the parts of the game that changed, because some improvements require rebuilding the game. If you decline, you
keep playing with the current game and you can start the rebuild later from the launcher's home screen.

Uninstall: UNINSTALL button on the launcher's CONSTRUCTION page, or double-click uninstall.bat. Everything the
package wrote on the PC is deleted: this folder, the built game and the compiler copy (C:\ProgramData\StarFoxRecomp).
Your game copy is never deleted, and your saves (%APPDATA%\SpaceAnimalsRecomp) only if you ask.

The video clips behind the launcher (gameplay recorded by SerenityG4K) come with the package. The game icon is taken
from your copy and never leaves your PC.
Your copy is never modified (read-only).

Licences: SpaceAnimalsRecomp is under the GNU GPL v3. The outils folder contains third-party free software, unchanged
(GCC, Clang/LLVM, binutils and MinGW-w64 from WinLibs, glslang, Python): their licences and the addresses of their
source code are in THIRD_PARTY_NOTICES.txt, and the full licence texts in the LICENCES folder.

Star Fox is a trademark of Nintendo. Fan project, not affiliated with Nintendo.
