Project Honeydew 0.3.1 (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.3.1, online everywhere: host and join from the game's own Online page
(Settings > Online; at the title also F4 or Y), in the headset too; the
launcher's Online tab is gone. The Quest version plays online too, with another
Quest or with the Windows, Linux and Steam Frame packages of the same version
(no voice chat on the Quest yet). Room codes stay hidden until you hold Show, and
in VR the keypad page is kept off the desktop window. Host and Join no longer
freeze the game while it checks its files; during a day, hold Disconnect for a
second to leave. Fixes: in VR, closing the settings page with a laser pull no
longer leaves that hand's trigger stuck; in co-op, your Onion menu shows in
front of you in the headset. Both players need 0.3.1.

0.3.0: the Windows, Linux and Linux ARM64 (Steam Frame) packages of the
same version play online together. Petting works (Pikmin wait for your hand);
hold the throwing stick up to look from above; a new settings page in the
headset (a Controls tab, a quick bar, scrolling by dragging, a resolution that
asks before it stays); Skip All Cutscenes, and skipping no longer loses a ship
part; better hand camera photos and selfies; the helmet off by default; Hide HUD
for footage; tips off by default and cards one at a time; a closer, bigger
tabletop; room codes for online play; health bars at eye level; no stalls on
graphics changes; the game's own music and effects volumes; the launcher offers
a desktop shortcut and a Start menu entry. Both players need 0.3.0.

0.2.9 (from the Steam Frame test): no IP address on screen (codes
show only their first letters); one microphone question at first start, and
no microphone opens until you answer; dismissing takes holding the stick
straight down; a
new settings menu in VR worked with the stick (left menu button: pause, map,
skip; right: settings, for either hand); your own controller's buttons in the
game's screens; no hands in cutscenes; no Nintendo-made pictures in the
download. The launcher: a one-press install (it finds your disc image), Update
straight from the downloaded zip (checked against the site's checksum), a
note when a new version is out (Settings > Launcher turns it off), no more
cover art downloads, Paste buttons, no overlapping boxes. An experimental
ARM64 package for the Steam Frame. Both players need 0.2.9.

0.2.8 (from a Quest 3 session with friends): throws back to 0.1.0's
weight and arc (Throw Assist only nudges the aim; 0% for none); the grip takes
the Pikmin you reach for (a white ring shows which); the camera rides over your
throwing hand's shoulder; no more accidental mutes (touch the microphone badge
on your watch to mute) and the voice settings in a new Audio tab; a bigger
settings page in the headset that you point at; hold the walking hand's menu
button for a second to skip a cutscene (a skipped one still does what it had
to, like ending day 1); the Steam Frame's left D-pad changes colour, dismisses
and turns; online, your friend sees your captain's own arms, not your gloves.
No more white flicker in the opening or from photos; the ping shown is the real
round trip, and a slower PC no longer slows the game for both players. Stereo
sound again, and the text's colours. A Meta Quest 3 through Link is tested
(connect it first, then SteamVR, then Play), and Add to Steam in the launcher
starts the game from Steam or the headset's library. A first Linux package,
too. Both players need 0.2.8.

0.2.7: which headsets work (README-VR.md, Supported headsets: tested on the
original HTC Vive; Valve Index, Steam Frame, Meta Quest through Steam Link, Air
Link or Virtual Desktop and others untested, please report). Steam Frame
controllers have their own binding; on stick controllers, flick the right stick
to turn, change colour or dismiss. Online works at any headset refresh rate
(matching rates are smoothest), and the camera on a monitor moves at the right
speed again online and in FPS Mode 60 / 120. Both players need 0.2.7.

0.2.6 (from a headset session): lighter throws (an ordinary swing goes
about 6 m), no grabbing back the Pikmin you just let go of, Wave to Recruit
every second; the camera in a holster at your throwing hand's hip; the time of
day as a watch on the back of your left wrist and a readable wrist radar; hold
the left menu button to open the map; Immersive cutscenes snap-only and never
flashing; the Forest Navel is a cave; Onion seeds no longer land in walls;
slopes slide as on the GameCube; Pikmin Parrot higher; no splash buzz at an
underwater wall. Both players need 0.2.6.

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; 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 and a Meta
  Quest 3 through Link. Other SteamVR headsets (Valve Index, Steam Frame
  streaming from your PC, other Quests) should work but are untested: see
  README-VR.md, "Supported headsets".
- 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. 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): README-VR.md, "Starting from Steam".

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.
   A Meta Quest: put it on and turn on Link (or Air Link), or start the
   Steam Link app or Virtual Desktop, FIRST; wait for the PC's VR home in
   the headset, then start SteamVR. (Started too early, SteamVR stops with
   error 1114 or 108, and the game plays on the monitor.)
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: in the headset on the VR tab (on
the monitor the VR tab is the last one). Point at the page with either
hand and pull the trigger.
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 the leaf or Pikmin you reach for (a white ring at its feet
           shows which); with nothing in reach, hold to send the squad
           where you point
  Menu     pause (hold: the map); in a cutscene, hold it 1 s to skip
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 the Pikmin you reach for; reach back over your right
           shoulder for the hand camera
  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 a watch on the back of your left wrist: raise it and look.
  Online, touch the microphone badge on it with your other hand to mute or
  unmute voice chat.
  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 players, one game)
------
In the game, open Settings > Online (F1 or Select; at the title also F4 or Y).
One of you chooses Host a game, the other Join a game, and types the host's
six-character room code on the keypad. Whoever's save you play is Olimar, the
other plays Louie: one of you picks "Your save", the other "Your friend's
save". If your friend can't reach you, let them host and keep the same save
choices: you still play your own save. Both need the same Project Honeydew
version, their own copy of Pikmin (GameCube, USA) and the same gameplay
settings; any headset refresh rate works (the same rate as your friend's is
smoothest). Windows, Linux, the Steam Frame and the Quest play together; a
Quest has no voice chat yet. The room code shows as KX7-***: hold Show to read
it, and send it only to your friend. If the room service can't be reached, the host's page can
copy a long join code instead (the friend pastes it on the keypad), and Paste
reply takes a reply code back. During a day, hold Disconnect for a second to
leave. 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.
Hosting asks a public STUN server for your internet address and
projecthoneydew.com for the room code; your router is asked for a port only if
you turn on "Open a router port". 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.
