Scooby-Doo! Mystery Mayhem - PC port  (version: see VERSION.txt)
==================================================================

An unofficial fan-made PC port of the 2003 PlayStation 2 game "Scooby-Doo! Mystery Mayhem". The
game's program was rewritten for Windows PCs; the game itself (levels, characters, music, voices,
videos) is NOT included and is read from a disc image of YOUR OWN PS2 game disc. It plays the
original game as it was on the PS2: same story, levels, menus and saves, in a resizable window or
full screen, with keyboard, mouse or a gamepad.

Project page (GitHub): https://github.com/Campfirecrucifix/scooby-doo-mystery-mayhem-pc
Bug reports and questions: the Issues page of the project's GitHub repository (the address above,
then "Issues").

Contents
  1. What you need            6. Controls
  2. Making a disc image      7. Where your files are (settings, saves, logs)
  3. System requirements      8. Uninstalling
  4. Quick start              9. Troubleshooting / FAQ
  5. The launcher            10. Reporting a bug
                             11. Command line (advanced)
Also in this folder: CHANGELOG.txt (what is new, known issues), NOTICE.txt (legal), LICENSES.txt
(third-party software licences), MPL-2.0-source.zip (source code of the MPL-2.0 licensed components,
see LICENSES.txt; not needed to play), VERSION.txt.


1. What you need
----------------
- Your own original PS2 disc of Scooby-Doo! Mystery Mayhem and a PC DVD drive to read it once.
- A disc image (.iso) made from that disc (next section). This port does not include, download or
  link to any game data; please do not ask for disc images.
- Which disc? The port was developed and tested with the European SCEE disc PBPX-95506. The North
  American disc (SLUS-20701) and the European retail disc (SLES-51883) are recognised and allowed
  but UNTESTED: the launcher says so, and reports from players with those discs are very welcome
  (section 10).


2. Making a disc image of your disc
-----------------------------------
Copying the files off the disc in Explorer is NOT enough: you need a 1:1 image of the whole disc.
- Put the disc in your PC's DVD drive.
- Use any disc-imaging program that can "create an image file from a disc" and save it as an .ISO
  file (plain ISO, 2048-byte sectors). Many free tools can do this; on Linux, `dd if=/dev/sr0
  of=scooby.iso` works.
- The result is one file of a few GB. Keep it anywhere on your PC, ideally on a local drive (not a
  network share).
Accepted: .iso, .img, .bin (also raw 2352-byte images), and a .cue sheet next to its .bin.
Not accepted: compressed images (.cso, .zso, .chd) and archives (.zip, .7z, .rar): convert / extract
them to a plain .iso first. The launcher tells you which of these it found.


3. System requirements
----------------------
- Windows 10 or Windows 11, 64-bit.
- A graphics card with a current driver that supports DirectX 12 or Vulkan (the renderer, wgpu,
  picks the best of the two automatically). Practically every dedicated or integrated GPU from about
  2014 on qualifies; very old GPUs that only support DirectX 11 / OpenGL are not supported.
- Memory: the game uses about 0.7 GB of RAM while playing; 4 GB of system RAM or more recommended.
- Disk: about 200 MB for this folder, plus your disc image.
- Sound: any Windows audio device. Input: keyboard (+ mouse) or a gamepad (Xbox / PlayStation /
  Switch Pro and most other controllers Windows recognises).
Tested on: Windows 11, Intel Core i9-14900KF, NVIDIA GeForce RTX 4080 SUPER. The game runs its logic
at the PS2's own rate, so a faster PC does not make the game itself faster; a slower PC can drop
frames. Lower-end hardware has not been tested yet - reports welcome.


4. Quick start
--------------
1. Unpack this whole folder somewhere you can write to, e.g. Documents\ScoobyMM or
   D:\Games\ScoobyMM. (Not into C:\Program Files: the game keeps its settings.toml in this folder.)
   Keep the files together.
2. Double-click "Scooby-Doo Mystery Mayhem.exe" (the launcher).
3. Click Browse... and choose your disc image (on the first start the launcher says "First, choose
   your disc image (Browse...) to unlock PLAY."). (If the image is in this folder, its parent folders,
   Documents, Downloads or the Desktop, the launcher finds it by itself.) The line below it shows
   the disc's release once the image is accepted (an amber line = accepted with a warning, e.g. an
   untested release).
4. Click PLAY. The game boots like the disc: logos, intro, title screen -> Start a new game.
Windows SmartScreen may warn about an unknown publisher the first time: choose "More info" -> "Run
anyway".


5. The launcher
---------------
Home page:
- GAME DISC IMAGE: the chosen image and what was found (the release of the disc, or why it cannot be
  used). Browse... / Change... picks another image. The disc's own title art appears once a valid
  disc is chosen.
- PLAY: starts the game (only enabled with a valid disc). If the game ever stops with an error, the
  launcher shows the reason here.
- Settings: the settings pages below.  Open log folder: opens the folder with the log files (section
  7).  Report a bug: opens the project's GitHub Issues page (section 10).
- Quit.
Settings pages (tabs):
- Graphics: Display mode (Windowed / Borderless fullscreen / Fullscreen; default Borderless), Window
  size, VSync (default on), FPS cap (off / 30 / 60 / 120 / 144 / 240; default off), Anti-aliasing
  (off / 2x / 4x / 8x MSAA; default 4x).
- Audio: Master volume, Music, Sound effects, Voice / movies, Mute. These work on top of the game's
  own Options volumes.
- Controls: Stick deadzone, Trigger threshold, Mouse moves the camera (+ Mouse sensitivity), Invert
  camera Y, and the binding rows: choose an Action (PS2 button / stick direction), then its two
  keyboard keys (Key 1 / Key 2) and its Gamepad button, either from the lists or with "Press key 1"
  / "Press key 2" / "Press button" followed by the key / mouse button / pad button you want (Esc
  cancels). "Reset controls" restores the default controls.
- Remaster: options for a separate remaster build; they stay greyed out in this release (not
  included).
- Restore defaults resets the page you are on; Save writes settings.toml; Back returns to the home
  page.
- "Skip launcher next time": PLAY starts the game directly from then on. Hold Shift while starting
  "Scooby-Doo Mystery Mayhem.exe" to get the launcher back.
The launcher can be used with the keyboard (Tab / Shift+Tab, arrows, Enter = PLAY, Esc = Back on
the settings pages / Quit on the home page, Ctrl+Tab = next tab) or with an Xbox-compatible gamepad
(D-pad / stick, A = press, B = same as Esc, LB / RB = tabs, Start = PLAY).
The same settings are also inside the game: Pause -> Options -> PC SETTINGS (SELECT button), with
the pages GRAPHICS, AUDIO, CONTROLS and BUTTONS (press-to-bind). Volumes, window mode / size, VSync,
FPS cap and controls apply at once; anti-aliasing changes apply when the game is restarted (marked
"(R)").


6. Controls
-----------
The game shows PS2 button names on screen (X, Circle, Square, Triangle, L1, R1, ...). Default
mapping:

  PS2 button          Keyboard / mouse               Gamepad (Xbox / PlayStation)
  ------------------  -----------------------------  ------------------------------------
  Left stick (move)   W A S D                        left stick
  Right stick (cam.)  arrow keys                     right stick
  X (Cross)           Space or J                     A / Cross
  Circle              L or O                         B / Circle
  Square              U or K                         X / Square
  Triangle            I or Backspace                 Y / Triangle
  L1 / R1             Q / E                          LB / RB (L1 / R1)
  L2 / R2             Z / C                          LT / RT (L2 / R2)
  L3 / R3             Left Shift / R or middle mouse left / right stick click
  Start (pause)       Enter (Esc also pauses)        Start / Menu / Options
  Select              Tab                            Back / View / Share
  D-pad               Numpad 8 2 4 6, or 1 2 3 4     D-pad
                      (1 = up, 2 = down, 3 = left, 4 = right)

Fixed keys: Esc = pause (Start), F11 = toggle fullscreen, Alt+F4 = close the game. In the game,
Pause -> Quit returns to the main menu. In menus (title, pause, PC SETTINGS) the arrow keys move
like the D-pad and Backspace goes back (Triangle), as in the original PC key table; in gameplay the
arrows turn the camera.
Optional: "Pause when the window loses focus" (launcher Controls tab, or PC SETTINGS -> CONTROLS ->
PAUSE ON FOCUS LOSS; off by default) pauses the game when you switch to another window.
Gamepad buttons are mapped by position (the bottom face button is X/Cross on every controller; on a
Nintendo Switch Pro controller that is the "B" button). The mouse can steer the camera: turn on
"Mouse moves the camera" in the launcher (Controls) or in the game's PC SETTINGS. Keyboard and
gamepad work at the same time; with several gamepads, pressing a button (or trigger) on one makes it
the active pad; a drifting stick on another pad cannot take over. Gamepads can be plugged in while
the game runs. Short key taps are never lost (even a very quick tap counts once).
Mouse in a window: with the mouse camera on, the cursor is hidden and kept inside the window while
you play; it is free and visible in menus, movies and cut scenes. The click that brings the window
back to the front is not passed to the game.
Experimental: "PC key prompts (experimental)" (launcher Controls tab, or PC SETTINGS -> CONTROLS ->
PC KEY PROMPTS; off by default) shows the bound keyboard key, e.g. "[I]", instead of the PS2 button
icon in menu prompts while you play with the keyboard.


7. Where your files are
-----------------------
Press Win+R and type  %LOCALAPPDATA%\ScoobyMM  to open the folder with your saves and logs.
- Saves (the PS2 memory card): %LOCALAPPDATA%\ScoobyMM\saves\memcard1
  (C:\Users\<you>\AppData\Local\ScoobyMM\saves\memcard1). Saving and loading work exactly as on the
  PS2 (the game's own Save / Load menus and checkpoints). Only one game at a time can use a memory
  card: a second game window started with the same card says "already running with this memory card"
  and closes.
- Settings: settings.toml in the game folder (next to the .exe files). Delete it to go back to all
  defaults.
- Logs: %LOCALAPPDATA%\ScoobyMM\logs - game.log (what the game printed in its last run;
  game.prev.log = the run before) and crash.log (errors and crash reports, newest at the end). The
  launcher's "Open log folder" button opens it.
- Cache: %LOCALAPPDATA%\ScoobyMM\cache - the launcher's title picture taken from your disc (safe to
  delete).
Backing up your saves: close the game, then copy the whole folder %LOCALAPPDATA%\ScoobyMM\saves
somewhere safe (a USB stick, cloud folder, ...). To restore it (also on another PC), close the game
and copy the folder back to the same place. Saves made with an earlier build that kept them in a
"saves" folder next to game.exe are copied over automatically the first time (only if the new folder
is still empty).


8. Uninstalling
---------------
1. Back up your saves if you want to keep them (section 7).
2. Delete the game folder (the one with "Scooby-Doo Mystery Mayhem.exe"; this also removes
   settings.toml).
3. Delete the folder %LOCALAPPDATA%\ScoobyMM (saves, logs, cache).
That is all: the game installs nothing else and writes nothing to the registry. Your disc image is
not touched; delete it separately if you no longer want it.


9. Troubleshooting / FAQ
------------------------
The game does not start / closes at once
- Start it with the launcher: if the game stops with an error, the launcher shows the reason.
- Keep game.exe and "Scooby-Doo Mystery Mayhem.exe" in the same folder ("game.exe was not found"
  otherwise).
- Make sure the folder is writable (not C:\Program Files, not a read-only or synced folder that is
  offline).
- Update your graphics driver (NVIDIA / AMD / Intel website, or Windows Update).
- Some antivirus programs block unknown new .exe files: allow the folder, or restore the file from
  quarantine.
- Look at the end of %LOCALAPPDATA%\ScoobyMM\logs\crash.log; it names the problem.

The game closes during play with a message
- "The game disc image is gone / can't be read any more": the image was moved, deleted or its drive
  (USB stick, network share) was disconnected. Reconnect it and start the game again; your
  memory-card saves are kept.
- "The graphics device stopped responding" / "The graphics driver reported an error": the graphics
  driver was reset or crashed. Update the graphics driver and start the game again; your saves are
  kept.

"Wrong disc" / the launcher does not accept my image
- "not a disc image" / "no ISO-9660 file system": the file is not a real image of the disc; make a
  new one (section 2).
- "this is a .zip / .7z / .rar archive": extract the .iso from it first.
- ".cso / .zso / .chd images are not supported": convert it to a plain .iso.
- "a PS2 disc, but not Scooby-Doo! Mystery Mayhem": the image is a different game.
- "... is missing (damaged or incomplete image?)": the image is incomplete; make it again from the
  disc.
- "untested, please report problems": your disc release has not been tested yet. It may well work;
  please report how it went.
- "on a network share: may stutter": copy the image to a local drive.

Black screen
- Wait a few seconds: the first start initialises the graphics, and the game shows the PS2 logo
  movies and a memory-card check before the title.
- Press F11 or switch Display mode to "Windowed" in the launcher (Settings -> Graphics), then try
  "Borderless fullscreen" again.
- Update the graphics driver. On a laptop with two GPUs, make Windows use the dedicated GPU for
  game.exe (Settings -> System -> Display -> Graphics).
- Advanced: force the other graphics API by setting the environment variable WGPU_BACKEND=vulkan (or
  =dx12) before starting the launcher.

No sound
- Check the launcher's Audio page (Mute off, volumes up) and the game's own Options -> Sound
  volumes.
- Check the Windows volume mixer and that the right output device is the default one. If you plug in
  headphones or change the output device while playing, the sound (including a running movie's
  sound) moves to the new default device after a moment.
- Starting game.exe directly (without the launcher) runs muted unless you add --sound (section 11);
  use the launcher.

Controller not detected
- Connect it before starting, or press a button on it after plugging in; with several pads, the last
  one on which a button was pressed is read (moving a stick alone does not switch pads).
- Xbox and most XInput pads work directly. For PlayStation / Switch Pro controllers, close Steam
  (Steam Input can hide or remap the controller) or set Steam to pass it through; third-party DS4
  drivers that emulate an Xbox pad also work.
- If buttons are wrong, use Controls -> "Reset controls" in the launcher, or delete settings.toml.
- Stick drifts / reacts too late: change "Stick deadzone" (Controls page).

Stutter / slow game
- Keep the disc image on a local drive (USB sticks and network shares can cause hitches while levels
  load; a single failed read is retried once before the game reports the disc as gone).
- Try VSync on and FPS cap 60, a smaller window, or Anti-aliasing off; close heavy background
  programs.
- Laptops: plug in the charger and use the dedicated GPU.
- The game itself always runs at the PS2's speed; if it feels slow, report it with your logs
  (section 10).

The game is in a small window / wrong size
- Settings -> Graphics: Display mode and Window size, or press F11.

My saves are gone
- Saves are per Windows user in %LOCALAPPDATA%\ScoobyMM\saves\memcard1 (section 7). A different
  Windows user account has its own saves. The game folder itself holds no saves.


10. Reporting a bug
-------------------
Please include:
- VERSION.txt (or the version shown in the launcher's corner),
- which disc you have (the launcher shows the release, e.g. "SCEE disc PBPX-95506"),
- what you did and what happened (episode / level, a screenshot if possible),
- the files crash.log and game.log from %LOCALAPPDATA%\ScoobyMM\logs ("Open log folder" in the
  launcher),
- your Windows version, CPU and graphics card.
(Developers: the separate ScoobyMM-<version>-symbols.zip holds game.pdb; unpacked next to game.exe
it adds file:line to the backtraces in crash.log.)
Never attach your disc image or any file from the disc. The log files contain no personal data apart
from file paths on your PC (which can include your Windows user name); edit them out if you prefer.
Where to report: the Issues page of the project's GitHub repository (the address is at the top of
this file; the launcher's "Report a bug" button opens that page).
Please search the existing issues first and add to a matching one instead of opening a duplicate.


11. Command line (advanced)
---------------------------
  game.exe [--iso <path>] [--sound] [--res WxH] [--aspect 4:3|16:9|21:9|32:9|auto] [--version]
- --iso: the disc image (default: the one chosen in the launcher, else "Scooby Doo Mystery
  Mayhem.ISO" next to game.exe or in a parent folder).  --sound: play sound (the launcher always
  adds it).
- --res: window size.  --aspect: picture aspect (default auto).  --version: print the version and
  exit.
"Scooby-Doo Mystery Mayhem.exe --settings" opens the launcher even when "Skip launcher next time" is
on.


Legal: unofficial fan project, not affiliated with or endorsed by Warner Bros., Hanna-Barbera, THQ
or Artificial Mind & Movement. Scooby-Doo and all related characters and elements are trademarks of
and (c) Hanna-Barbera.
No game data is included. Details: NOTICE.txt; third-party software licences: LICENSES.txt.
