Project Honeydew 2 - legal notice
=================================

Project Honeydew 2 is a VR mod for Pikmin 2 (GameCube): a fork of Open Nectar, a native PC port
of the projectPiki decompilation of Pikmin 2, that adds virtual reality (SteamVR on PC, OpenXR on
the Meta Quest).

IT IS UNOFFICIAL AND NOT AFFILIATED WITH OR ENDORSED BY NINTENDO. You need your own copy of the
game: no Nintendo files are included in its packages. Pikmin, Nintendo, Nintendo GameCube and their
names, characters, graphics, audio and other resources are trademarks or materials of their owners;
the name Pikmin appears only to say which game this is for, and nothing here grants any licence
over them.

It is free. Its packages are not sold, and no feature, build or file depends on a payment.

Open Nectar's rules, which this fork keeps
------------------------------------------
Open Nectar is an independent community engineering and preservation project. Its CC0 1.0
dedication (licenses\Project-Honeydew-and-Open-Nectar-CC0-1.0.txt) applies only to contributions
over which their authors could make such a waiver; it does not make the game, or anything else a
player needs to run it, freely available. Neither the source, nor the packages, contain disc
images, the game's files, keys, saves or settings, and no package combines the port with the
game's data. Each player is responsible for obtaining and using their copy in accordance with the
law where they live. This text is a project guide and not legal advice.

What Project Honeydew 2 adds, and what it does
----------------------------------------------
Its additions are the VR layer, the launcher, the packaging and the guides, offered under the same
CC0 1.0 dedication as the rest of Open Nectar.

No game data. The game reads everything of the game's own from the player's installation, which
the launcher extracts from the player's own copy. Pieces of the game's data that upstream had
compiled into the source (a font texture, memory card icons, DSP microcode) are compiled into
nothing here, and the packaging checks every program for them before a package is made. The
decompiled program keeps the small tables its code computes with (math, character-code and audio
tables): functional data, part of the program, not images, sounds or models a player sees or hears.

Your copy of the game. The launcher reads the copy you choose on your computer (ISO, GCM, CISO or
NKit files; RVZ, WIA and GCZ through Dolphin's own dolphin-tool, if you have it) and writes nothing
but the extracted files into the folder you choose. It compares a plain copy with the checksum of
the copy the project tests with, and tells you when yours differs (you may install anyway). It
removes no protection, downloads nothing of the game, and sends nothing anywhere. To find your copy
it looks only at file names and the 6-byte disc ID in a file's header, in your Downloads, Desktop
and Documents folders and your drives' top folders, only while the install card is open.

Network. The game itself has no network features (its Speedrun mode can talk to LiveSplit on this
PC only). The launcher's one use of the network is the update check: when it opens, it reads one
small file, https://projecthoneydew.com/honeydew2/latest.json, with no identifier or cookie, to say
whether a newer version is out. The switch on its home screen turns that off. Nothing is
downloaded or installed by it; an update is a file you download yourself and choose in the
launcher, which checks its checksum before installing it.

SteamVR and Steam. The game talks to SteamVR through Valve's OpenVR library (openvr_api.dll on
Windows, libopenvr_api.so on Linux; BSD 3-Clause). The launcher's Add to Steam adds one entry,
Project Honeydew 2, to Steam's list of non-Steam games on this PC, only when you press it (on
Windows only while Steam is closed, keeping the old list beside it); a new installation on SteamOS
adds itself the same way. The controllers' shapes come from SteamVR on your own PC at run time;
none ship with Project Honeydew 2.

Shortcuts. The launcher makes a desktop shortcut and a Start menu entry (on Linux: the applications
menu) only when you tick them.

Microphone. The game asks once whether it may use your microphone, and only with your yes does it
listen while it runs: to notice whistling (Mic Whistle) and how loud and how steady your voice is
(Pikmin Hear You). The sound is analysed in memory and is never recorded, stored or sent anywhere.

Photos. The hand camera's photos are PNG files in your Pictures folder, under Project Honeydew 2
(on the Quest: the headset's gallery). They stay on your device.

Logs. Everything the game prints also goes to game-log.txt in its folder (the run before:
game-log-previous.txt), with your user name, home folder and computer name taken out. The logs
stay on your computer; nothing is uploaded. Settings > Data > Copy the Log copies the log, or the
last crash's report, for you to paste into a bug report.

Crash reports. If the game crashes it writes pikmin2_crash.log (the version, the error, where it
happened and the log's last lines, with the same names taken out) and pikmin2_crash.dmp (a
minidump, on Windows: part of the game's memory at the crash, which can hold anything the game had
loaded) in its folder, and closes without Windows' crash dialog, which would offer to send a report
to Microsoft. Nothing is sent anywhere; you decide whether to share the files, and with whom (never
post the .dmp publicly).

The gloves. The player's gloves (vr\olimar_gloves.bin) are a 3D model made for Project Honeydew
(Honeydew 1) with ChatGPT / Codex, inspired by Olimar's look in Pikmin, which is Nintendo's; it was
modelled for the mod, not taken from the game.

Artwork. The icons, the launcher's banner and SteamVR's library image are Project Honeydew 2's own
badge and wordmark; the lettering is set in Quicksand (SIL OFL 1.1).

Made with AI assistance. The VR layer, the launcher, the packaging and the guides of Project
Honeydew 2 were written with AI assistance (Anthropic's Claude) and play-tested on a real headset.

Third-party components in the packages: OpenVR (BSD 3-Clause), SDL 2 (zlib), Dear ImGui (MIT),
stb_image and stb_truetype (MIT or public domain), bcdec (MIT or Unlicense), xxHash (BSD 2-Clause),
the NextOS software JAudio renderer (MIT), the Fredoka font (SIL OFL 1.1), DejaVu Sans Mono's
characters (Bitstream Vera licence) and the GCC runtime libraries (on Windows also MinGW-w64's).
Their licence texts are in the licenses folder, with THIRD-PARTY-NOTICES.txt.

Contact: projhoneydew@gmail.com - https://projecthoneydew.com
