Project Honeydew 2 0.1.0 preview (Open Nectar 1.0.4 base) for Linux
=====================================================================
This package: ProjectHoneydew2-0.1.0-linux-x86_64, for 64-bit PCs (x86-64) and the Steam Deck.

Be the captain: Pikmin 2 in virtual reality, on Open Nectar's native PC
port of the game. The sequel to Project Honeydew (Pikmin in VR).

Unofficial fan project; not affiliated with or endorsed by Nintendo.
Nothing from the game is included: no game data, art, music or text. The
game reads all of it from your own copy of Pikmin 2.

GUIDE.md (open it with any text editor or browser) is the full guide: every
control, every setting.

THE LINUX PACKAGE IS NEW AND UNTESTED ON REAL LINUX HARDWARE. Each package
is checked automatically before it is shared, on a Linux system without a
headset: started flat, and played with an emulated headset. Nobody has
played it on a Linux PC with SteamVR or on a Steam Deck yet. If you try it,
please say what works and what doesn't: your distribution, graphics card
and driver, headset, and game-log.txt from the game's folder.


WHAT YOU NEED
-------------
  - Your own copy of Pikmin 2 (GameCube, USA).
  - 64-bit Linux on a PC (x86-64) with glibc 2.31 or newer: Ubuntu 20.04,
    Debian 11, Fedora 32, SteamOS 3 or anything newer (Mint, Pop!_OS, Arch,
    openSUSE Tumbleweed...), in an X11 or Wayland session.
  - An OpenGL 4 graphics driver (Mesa for AMD and Intel, or NVIDIA's). In
    the headset the world is drawn for both eyes at once with the driver's
    GL_OVR_multiview (glxinfo | grep OVR_multiview shows whether it has it).
  - For VR: Steam with SteamVR, and a headset SteamVR supports on Linux.
    Use Steam from your distribution or Valve's own package: with the
    Flatpak or Snap Steam the game may not find SteamVR.
    Without SteamVR or a headset the game plays on the monitor.
  - About 1 GB of free disk space for the game's files.


INSTALLING (on the flat desktop: on SteamOS, in Desktop Mode, not in VR)
-------------------------------------------------------------------------
1. Extract this archive anywhere: in the file manager, right-click it and
   Extract Here (no terminal needed), or tar -xzf ProjectHoneydew2-0.1.0-linux-x86_64.tar.gz.
   You get one folder, ProjectHoneydew2-0.1.0-linux-x86_64.
2. Open ProjectHoneydew2 in that folder (double-click it, or
   ./ProjectHoneydew2 in a terminal there): the launcher.
3. Press Install. It looks for your copy of Pikmin 2 (GameCube, USA) and
   suggests ~/Games/Project Honeydew 2 to install to: press Install (or
   choose another copy or folder). It checks your copy, writes the game's
   files into the installation's "assets" folder and copies the game there;
   your copy is only read.
4. Press Play. For VR, start SteamVR first.
From then on, start the launcher in the folder you installed to (or its
menu entry, or Steam) and press Play.

Your copy: an ISO or GCM, or a CISO or NKit file. RVZ, WIA and GCZ work with
dolphin-tool from a Dolphin installation (on the PATH or beside the launcher).
The launcher's file choosers need zenity or kdialog (most desktops have
one). Without them, or without a desktop, install from a terminal:
  ./ProjectHoneydew2 --game ~/pikmin2.iso --install-dir ~/Games/ProjectHoneydew2

Updating: in the installed launcher, press Update and choose the new
download (the .tar.gz as you downloaded it, or its extracted folder). Your
saves, settings and texture packs stay.


PLAYING ON STEAMOS (STEAM DECK) - START IT FROM STEAM
-----------------------------------------------------
(The Steam Frame itself needs the ARM64 package,
ProjectHoneydew2-0.1.0-linux-arm64. This one runs on 64-bit PCs, and on
a PC that streams to a Steam Frame through SteamVR.)
On SteamOS the controllers only work when Steam starts the game. A new
installation adds itself to Steam while Steam runs (Desktop Mode); if it
didn't, press Add to Steam in the installed launcher. Then play Project
Honeydew 2 from your Steam library (Game Mode too). To go straight into the
game, give it the launch option --play (its Properties in Steam).
The Steam Deck is not a VR headset: there the game plays flat, on its own
screen, with the Deck's controls when Steam starts it.


PLAYING ON OTHER LINUX
----------------------
1. Start Steam, then SteamVR. Wait until it shows the headset and both
   controllers.
2. Start the installed launcher and press Play. Its Shortcuts button adds
   Project Honeydew 2 to your applications menu and desktop, and Add to
   Steam to your Steam library.
The game must start in its installation folder (it loads "assets" from
there): the launcher, its menu entries and Steam's entry all do that.

Menus and cutscenes play on a big screen in front of you; the world is all
around you once you land. Hold the Start button for one second for the
settings (the VR tab holds the VR options). Hold both menu buttons to
recenter.


CONTROLS
--------
The card beside the pause menu shows your own controller's buttons.

Steam Frame (right-handed; Left-Handed in the VR tab swaps the hands):
  Left stick    walk (press it to run)
  Right stick   sideways: turn; flick up / down: next / previous colour;
                held up: look from above; held down: dismiss the squad;
                pressed: the colour wheel
  D-pad         the same as the right stick (up: next colour, down: the
                previous one - held, dismiss -, left / right: turn)
  Triggers      hold: a Pikmin in your hand; swing and let go to throw it
  Left grip     whistle where your left hand points
  Right grip    held: your squad swarms where your right hand points
  Y (or Menu)   tap: pause; hold 1 second: settings
  B             switch captains (back in the game's screens)
  A             the game's A (an Onion, the ship, a cave, a hole, a geyser)
  Left bumper   close a card
  B and Y held together: recenter.
Quest Touch, Index and Vive: the controls card in the headset shows them.


FILES THE GAME WRITES (in its own folder)
-----------------------------------------
  save/                     your saves
  pikmin_settings.conf      the settings
  game-log.txt              what happened this session (the last one's is
                            game-log-previous.txt): send it with a bug report.
                            Your user name, home folder and computer name are
                            taken out.
  pikmin2_crash.log         after a crash: what happened, for a bug report
  pikmin2.log, shader_cache/, vr/programs.list
                            the full log, and shaders kept for the next start
Nothing is ever uploaded. The launcher asks projecthoneydew.com whether a
newer version is out (nothing about you is sent; its switch turns it off).


IF SOMETHING GOES WRONG
-----------------------
  "libGL.so.1: cannot open shared object file"
      No OpenGL driver is installed. Debian/Ubuntu: sudo apt install libgl1;
      Fedora: sudo dnf install mesa-libGL; Arch: sudo pacman -S libglvnd.
  "GLIBC_2.31 not found" (or similar)
      The system is older than Ubuntu 20.04 or Debian 11.
  The launcher's Browse does nothing
      Neither zenity nor kdialog is installed (Debian/Ubuntu: sudo apt
      install zenity; Fedora: sudo dnf install zenity; Arch: sudo pacman -S
      zenity), or install from a terminal (INSTALLING above).
  The game says it cannot find the game files
      Start it from the launcher in the folder you installed to (the game
      loads "assets" from the folder it starts in).
  The game plays on the monitor only
      Start SteamVR first. game-log.txt says why VR didn't start (the lines
      starting with [VR]).
  The controllers do nothing (SteamOS)
      Start the game from Steam (see STEAMOS above).
  The game crashed
      It wrote pikmin2_crash.log in its folder (and says so at the next
      start). In the settings, Data > Copy the Log copies the report for you
      to paste; Report a Bug opens the bug form on projecthoneydew.com.
  The world looks flat in the headset (no depth)
      The graphics driver lacks GL_OVR_multiview, so both eyes get the same
      picture (game-log.txt says "mono world"). On an AMD or Intel GPU, try
      Mesa's zink driver: in Steam, the game's Properties > Launch Options:
          MESA_LOADER_DRIVER_OVERRIDE=zink %command%
      (in a terminal: MESA_LOADER_DRIVER_OVERRIDE=zink ./pikmin2_pc).


Contact: projhoneydew@gmail.com, or the form on projecthoneydew.com.

This is a preview: expect rough edges.


CREDITS
-------
  - The projectPiki team: the decompilation of Pikmin 2 this is built on.
  - The Open Nectar community: the native PC port (GX to OpenGL, audio,
    input, settings, texture packs).
  - The NextOS Elite contributors: the software JAudio renderer.
  - Valve: OpenVR.
  - Libraries: SDL, Dear ImGui, stb, xxHash, bcdec; the Fredoka and DejaVu
    fonts.
  - Project Honeydew 2: the VR layer, the launcher and these packages. They
    were written with AI assistance (Anthropic's Claude) and play-tested on
    a real headset.


LEGAL
-----
LEGAL.txt and the licenses folder. Pikmin and Nintendo are trademarks of
Nintendo; this project is not affiliated with Nintendo.
