Project Honeydew 2 0.1.0 preview (Open Nectar 1.0.4 base)
================================================================

Project Honeydew 2 is a VR mod for Pikmin 2 (GameCube, 2004): you are Captain Olimar and Louie, at
their size, with Pikmin you pluck with your hands and throw with a real swing. The sequel to
Project Honeydew (Pikmin 1 in VR).

An UNOFFICIAL fan project, built on Open Nectar (a native PC port of the projectPiki decompilation
of Pikmin 2). NOT affiliated with or endorsed by Nintendo. This package contains NO Nintendo files:
you need your own copy of Pikmin 2 (GameCube, USA), and the launcher installs the game from it.

This is a preview: expect rough edges, and please tell us what you find (IF SOMETHING GOES WRONG).

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


WHAT YOU NEED
-------------
- Windows 10 or 11, 64-bit. (Linux and the Steam Frame have their own packages on
  projecthoneydew.com, and the Meta Quest 3 / 3S its own app.)
- SteamVR and a PC VR headset: a Meta Quest through Link, Air Link or Virtual Desktop, a Valve
  Index, an HTC Vive, a Steam Frame streaming from the PC, and others SteamVR runs.
- A graphics card from NVIDIA or AMD with current drivers (the headset's view uses OpenGL's
  GL_OVR_multiview2).
- Your own copy of Pikmin 2 (GameCube, USA): an ISO, GCM, CISO or NKit file. RVZ, WIA and GCZ files
  work too with dolphin-tool from a Dolphin installation.
- About 1 GB of free disk space.
Without SteamVR or a headset the game plays on your monitor.


INSTALLING
----------
1. Extract this zip anywhere (no installer).
2. Run ProjectHoneydew2.exe.
3. Press Install. The launcher looks for your copy of Pikmin 2 (in Downloads, Desktop, Documents
   and your drives) and suggests a folder; Browse chooses others. Press Install.
4. Wait for "Installation complete" (a minute or two). Tick the shortcuts you want and press Open
   the launcher: the launcher of your new installation opens.
From then on, start Project Honeydew 2 from the shortcut, or ProjectHoneydew2.exe in the folder you
installed to. To start it from Steam, or from SteamVR's library in the headset, press Add to Steam
on the launcher's home screen (with Steam closed).
Your copy is only read: it is not copied, changed or sent anywhere.


UPDATING
--------
When a newer version is out, the launcher says so at the top right (it reads one small file from
projecthoneydew.com; the switch on its home screen turns that off). Download the new zip from
projecthoneydew.com, press Update in your installed launcher and choose the zip as it is (no need
to extract it). Your saves, settings and texture packs stay as they are.


PLAYING IN VR
-------------
1. Start SteamVR with your headset connected (a Meta Quest: put it on and start Link, Air Link or
   Virtual Desktop FIRST, wait for the PC's VR home in the headset, then start SteamVR).
2. Press Play in the launcher.
Title screens, menus and movies play on a big screen in front of you; in a stage you stand in the
world at the captain's size. The first time, a card asks how to turn, the controls card shows, and
a short tutorial follows (each step done by doing it).
Settings: hold Y for a second (Index: B, a Vive wand: the left menu button), or press F1 on the
keyboard. Point at the page with either hand and pull the trigger. B closes it.
Recenter: hold B and Y together for a moment.


CONTROLS (Meta Quest Touch, right-handed; Left-Handed in the VR tab mirrors them)
--------
With an Index, Vive wands or a Steam Frame, the game's controls card shows your own controller's
buttons (it shows at the first start; VR tab > Welcome and Tutorial shows it again).
RIGHT HAND
  Trigger  hold: the Pikmin your hand reaches for, else one of your chosen colour hops into your
           hand; swing and let go to throw it; let go gently to set it down. Closed round a
           sprout's stem: pull up to pluck. Under an Onion or the ship: open it.
  Grip     hold: your squad swarms where you point
  Stick    left / right: turn; flick up / down: next / previous colour; hold up: look from above;
           hold down: dismiss; press: the colour wheel
  A        the game's A where it does something (an Onion, the ship, a cave, a hole, a geyser)
  B        switch captains
LEFT HAND
  Trigger  the same as the right one: a Pikmin in each hand
  Grip     whistle where you point (at your mouth: whistle round you)
  Stick    walk; press it while walking to run
  Y        pause; hold 1 s: the settings
WITH YOUR HANDS
  Punch with a real jab. Pet a Pikmin's head with an open hand. Wave, clap, high-five, dance.
  The watch on the back of your left wrist: the time of day, the day, health and your Pikmin;
  turn the wrist over for the radar. Poke the spray buttons under the watch to spray.
  Walk in your room and the captain walks with you.


IF SOMETHING GOES WRONG
-----------------------
- The game starts on the monitor only: start SteamVR first, and check that VR is On in F1 > VR.
- Windows SmartScreen warns about the launcher: the files are not signed. More info > Run anyway.
- The game crashed: it wrote pikmin2_crash.log beside pikmin2_crash.dmp 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. Send pikmin2_crash.dmp only if asked (it
  holds part of the game's memory: never post it publicly).
- It misbehaved or froze: game-log.txt (this run) and game-log-previous.txt (the run before) in
  the game's folder hold everything it printed, with times, your user and computer names taken
  out. Nothing is ever uploaded.
- Contact: projhoneydew@gmail.com, or the form on projecthoneydew.com.


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.
