Project Honeydew 0.2.5 (Open Nectar 0.9.2 base)
================================================================

Project Honeydew is a VR mod for Pikmin (GameCube, 2001): you are Captain
Olimar, at his size, with Pikmin you pluck with your hands and throw with a
real swing. It was called Pikmin VR until 0.2.2.

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

Project Honeydew is free. If you'd like to support development:
https://ko-fi.com/projecthoneydew (optional; donations unlock nothing).

NEW IN 0.2.5: an Onion could stay unopenable for the day after you skipped the
morning landing with Start; it now finishes landing by itself. Both players
need 0.2.5.

0.2.4: the launcher fits 4K and other high-DPI screens; after installing,
the launcher of your folder opens (the game no longer starts by itself: start
SteamVR first, then press Play). Proximity voice chat carries to about 150 m.
First person with a controller turns steadily and places the throw circle.
Co-op: your whistle also calls the Pikmin following your friend. Online, your
gamepad rumbles only for your own captain, and the flat friend sees your VR
gloves at Olimar's arms. The hand camera never photographs itself and says
where each photo went. The pause menu has Back to the Ship for a stuck
captain, and skipping a cutscene no longer leaves him under the ground. Both
players need 0.2.4.

0.2.3: Pikmin VR is now called Project Honeydew (same project, same
saves and settings; update as before). Punches reach a little further;
plucking grabs a leaf from a little higher; a Pikmin you set down next to a
job takes it; Pikmin carrying a pellet no longer give up. In VR and online the
game's own timers run at GameCube speed again: drowning, carrying, knockbacks,
boss shake-offs, tripping, the Emperor Bulblax's walk, fire damage, Puffy
Blowhog gusts, enemy footsteps, the health ring, text boxes, the results
screen and the Y-menu map. Pikmin Parrot repeats only what was said (never a
whistle). Online: effects match on both PCs, fire fights stay in step after a
dropped link reconnects or in a second session, the throw colour starts at
none each day (a second session no longer desyncs at the first throw), and
photo mode (F3) is off. Both players need 0.2.3 (if not, the game
names both versions).

0.2.2: a gentler Throw Assist that never changes how far you throw; petting
a Pikmin no longer counts as a wave; a Skip button on the tutorial's
and co-op tips' cards (point at it, pull the trigger) instead of holding both
grips; Immersive cutscenes turn your view in quick cuts and warn you once;
first person on a monitor turns freely. Online: the F1 settings both games
share are locked during a session (set them before you host or join), Free
Camera may differ, and if the games ever fall out of step both write a desync
report.

0.2.1: co-op no longer crashes at sunset when Louie still has Pikmin
following him, and going back to the file select or the title (Continue from
last save, No at "Save?", Return to title) ends an online session cleanly
(host or join again to go on).

0.2.0: made for playing together. Either PC can host, whichever save
you play ("Whose save do you play?" in the Online tab); rejoin after a crash
with the same code; the friend keeps a copy of the co-op save; voice chat like
PEAK with a walkie-talkie; high fives, bonks and throwing your friend; Pikmin
that hear you; a VR tutorial, accessibility and quality settings; crash
reports that stay on your PC. Details in README-VR.md, "What's new in 0.2.0".

README-VR.md (open it with any text editor or browser) is the full guide:
every control, every VR setting, comfort tips, troubleshooting, building.
EASTER-EGGS.md lists the hidden surprises and how to find them: spoilers!


WHAT YOU NEED
-------------
- Windows 10 or 11, 64-bit.
- SteamVR and a PC VR headset. Tested on an original HTC Vive with the Vive
  wands. Valve Index and Oculus Touch bindings are included but untested.
- A graphics card from NVIDIA or AMD with current drivers. The 3D view in
  the headset uses OpenGL's GL_OVR_multiview2.
- A reasonably fast CPU: the headset wants 90 frames a second.
- Your own disc image of Pikmin USA Rev. 1 (GPIE01): ISO, GCM, or a CISO/NKit
  file. RVZ/WIA/GCZ also work with DolphinTool.exe from a Dolphin install.
- About 1 GB of free disk space.
Without SteamVR or a headset the game simply plays on your monitor.


INSTALLING
----------
1. Extract this zip anywhere (no installer; outside your folders the
   launcher only keeps a box-art cache in %LOCALAPPDATA%\PikminVR).
2. Run nectar-launcher.exe.
3. Press Install, choose your disc image and a folder to install to.
4. Wait for "Installation complete" (a minute or so) and press Open the
   launcher: the launcher of that folder opens. Start SteamVR first to play in
   VR, then press Play.
From then on, run nectar-launcher.exe from the folder you installed to and
click the Pikmin cover.

The launcher never downloads updates. To update, extract a newer Project
Honeydew zip, run its launcher, press Update and choose your installed folder;
your saves and settings stay (from Pikmin VR 0.2.2 and older too).


PLAYING IN VR
-------------
1. Plug the headset into your graphics card (not the motherboard) and
   start SteamVR. Wait until it shows the headset and both controllers.
2. Start the game from the launcher. The monitor mirrors your view.
3. Title screen, file select and movies appear on a big screen in front of
   you; in a stage you stand in the world at Olimar's size.
Hold both menu buttons to recenter. F1 on the keyboard, or the right
menu button in VR, opens the settings; the VR tab is the last one.
The first time, the game asks how to play: Classic (the original game in
VR) or Expanded (with the VR extras). Change it in the VR tab, Experience.


CONTROLS (Vive wands, right-handed; Left-Handed in the VR tab swaps them)
--------
LEFT WAND (walk and whistle)
  Pad      touch to walk, click to run
  Trigger  whistle where you point
  Grip     grab a leaf or Pikmin; with nothing in reach, hold to send
           the squad where you point
  Menu     pause
RIGHT WAND (Pikmin)
  Trigger  hold to grab a Pikmin, swing and let go to throw (let go gently
           to set it down)
  Pad      left/right turn, up next colour, down dismiss
  Grip     grab: reach down, grip a sprout's leaf and pull it up;
           pick up a Pikmin
  Menu     settings
BOTH HANDS
  Punch enemies (and Pellet Posies) with a quick jab.
  Pluck: grip a sprout's leaf and pull it up, with one hand or both.
  (Quick Pluck in the VR tab makes the trigger pluck instead.)
  Reach out slowly to a Pikmin and pat it on the head.
  Wave a hand at shoulder height: idle Pikmin come and join you.
  The HUD is on the inside of your left wrist: turn it towards you.
  Hold both menu buttons to recenter.
In menus: pad = move, right trigger = confirm, left trigger or grips = back.
These are also shown in the headset beside the pause menu.


ONLINE (two PCs, one game)
------
In the launcher's Online tab one of you presses Host: the game shows a join
code and copies it to the clipboard. Send it to your friend, who pastes it
under Join. Whoever's save you play is Olimar, the other plays Louie: by
default the host's save ("Whose save do you play?" at the top of the tab).
If your friend can't reach you, let them host and pick "Mine": you still play
your own save. Both need the same Project Honeydew version, their own copy of
the game, the same gameplay settings and headsets at 90 Hz. If the code doesn't
connect, the friend's game shows a reply code for the host to paste (Ctrl+V).
If a game crashes or drops out, start it again and join with the same code:
it catches up and you play on. Online play is story mode: Challenge Mode is
single-player for now.
A code asks a public STUN server for your internet address (your router is
asked for a port only if you tick that option); untick "Use a join code" to
connect by address instead. A VPN app on the host's PC hides it: turn it off
while hosting. Windows may ask about the firewall: allow Private networks.
Once connected, talk with the built-in voice chat (peer to peer, never
recorded); hold the walkie-talkie (K, or the throwing hand's grip and talk
button) to be heard anywhere. More in README-VR.md, "Playing online".


IF SOMETHING GOES WRONG
-----------------------
- "Display Connection Trouble" (436) in SteamVR: the headset is plugged into
  the motherboard's HDMI. Plug it into the graphics card.
- The game says Steam or SteamVR runs as administrator (error 310): untick
  "Run this program as an administrator" for steam.exe (Properties >
  Compatibility), restart Steam and SteamVR.
- Error 306 or 310 after SteamVR crashed: restart SteamVR, or the PC.
- The game starts on the monitor only: start SteamVR first, and check that
  VR is On in F1 > VR.
- Your captain is stuck, or fell through the world: pause and choose Back to
  the Ship (online too: the session goes on).
- Windows SmartScreen warns about the launcher: the files are not signed.
  More info > Run anyway.
- The game crashed: it wrote crash-report.txt beside nectar.exe (and says
  so at the next start). Send that file to whoever helps you; crash.dmp and
  game-log-previous.txt only if asked (crash.dmp holds part of the game's
  memory: never post it publicly).
- The game misbehaved, froze, or the PC crashed: send game-log.txt (this
  run) and game-log-previous.txt (the run before) from the game's folder,
  and after online play online-log.txt and online-log-previous.txt.
  They hold everything the game printed, with times, and survive a crash.
  They can contain file paths with your Windows user name and, after online
  play, IP addresses and join codes: look them over before posting them
  publicly. Nothing is ever uploaded.
More in README-VR.md, "Troubleshooting".


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