Hong Kong Phooey Mini-PUP

What does it do?
Play some clips from the Hanna-Barbera cartoon that first aired in 1974. It is meant to be used with Hursty's 2025 table Hong Kong Phooey that is a reskin of the Stern table Wild Fyre.
For file size reasons, the pup-pack contains only one full episode and a couple of clips.  If you want all 31 episodes that were created, download them from here: https://mega.nz/folder/ovtGwaLR#2ZKUu-iFAX0QaC_bs2cM8g and unzip them into the MusicVideos sub-folder (i.e. C:\vPinball\PinUPSystem\PUPVideos\HongKongPhooey\MusicVideos\) and get rid of the clips you don't want. The episodes eat 1.36 GB of hard drive space. Thanks to @trueanimus for the hint where to find the videos.

Preview:

Controls:
There are basic controls that were added to the table script. During game play, you can go to another random track with the right magnasave button. Pressing the left magnasave button stops the playback. The gameplay itself doesn't have any impact on video playback.

Manual coding:
Here are the instructions for manually applying the code to future updates of Hursty's original. All who don't want to apply code manually can skip this section and apply the VPU patch instead.
At the top of the table code, add:

'****** PuP Variables ******

Dim PlaySong: Dim cPuPPack: Dim PuPlayer: Dim PUPStatus: PUPStatus=false ' dont edit this line!!!

'*************************** PuP Settings for this table ********************************

PlaySong   = 1      ' 0=pup and music off, 1=enable Pinup Player functions for this table, 2=play music only
cPuPPack = "HongKongPhooey" ' name of the PuP-Pack / PuPVideos folder within PinUPSystem\PUPVideos for this table


'//////////////////// PINUP PLAYER: STARTUP & CONTROL SECTION //////////////////////////

' This is used for the startup and control of Pinup Player

Sub PuPStart(cPuPPack)
    If PUPStatus=true then Exit Sub
    If PlaySong=1 then
        Set PuPlayer = CreateObject("PinUpPlayer.PinDisplay")
        If PuPlayer is Nothing Then
            PlaySong=false
            PUPStatus=false
        Else
            PuPlayer.B2SInit "",cPuPPack 'start the Pup-Pack
            PUPStatus=true
        End If
    End If
End Sub

Sub pupevent(EventNum)
    if (PlaySong=0 or PlaySong=2 or PUPStatus=false) then Exit Sub
    PuPlayer.B2SData "E"&EventNum,1  'send event to Pup-Pack
End Sub

' ******* How to use PUPEvent to trigger / control a PuP-Pack *******

' Usage: pupevent(EventNum)
' EventNum = PuP Exxx trigger from the PuP-Pack
' Example: pupevent 102
' This will trigger E102 from the table's PuP-Pack
' DO NOT use any Exxx triggers already used for DOF (if used) to avoid any possible confusion

'************ PuP-Pack Startup **************

PuPStart(cPuPPack) 'Check for PuP - If found, then start Pinup Player / PuP-Pack

'***************************************************************************************

Usually, somewhere between the declaration of constants (lines starting with "Const") and the variable dimensions (lines starting with "Dim") is a good place to add that code.
After doing that, run the table to see if it is playable without throwing errors. The videos should be playing, but you won't be able to pause/skip, as we haven't added yet the corresponding code. Stop playing and go back to the editor, will ya?
Next, add the Magnasave controls by searching the existing code for

    If keycode = LeftMagnaSave Then bLutActive = True
    If keycode = RightMagnaSave Then 
        If bLutActive Then NextLUT: End If
    End If

and replace with:

    If keycode = LeftMagnaSave Then 
        bLutActive = True
        PuPevent 801
    End If
    If keycode = RightMagnaSave Then 
        If bLutActive Then NextLUT: End If
        PuPevent 800
    End If

Instructions:
1) Download the package and unblock it if applicable
2) Extract the folder "HongKongPhooey" into your PUP-pack folder (usually something like C:\vPinball\PinUPSystem\PUPVideos)
3) Download Hursty's table "Hong Kong Phooey (Hursty 2025)" v4.0.0 from

4) If you don't already have it, download the tool "VPURemix System - VPPatching System - VPX ONLY"
5) Use the VPURemix tool to apply the patch file "Hong Kong Phooey (Hursty 2025) 4.0.0 PUP.dif" that comes with the PUP-pack to Hursty's original table.

6) Put the resulting vpx file into your tables folder (e.g. C:\vPinball\VisualPinball\Tables\)

7) Extract the folder HongKongPhooey from the zip archive into your PUP-folder (e.g. C:\vPinball\PinUPSystem\PUPVideos\)

PUP-pack options:
The PUP-pack videos can be positioned on topper, backglass or full DMD screen, with or without an overlay. It comes with these options:
1-Video on backglass, no overlay
2-Video on backglass with overlay-frame
3-Video on fullDMD, no overlay
4-Video on fullDMD with overlay-frame
5-Video on topper, no overlay
To apply any of them, execute the corresponding batch file in the PUP-folder (e.g. C:\vPinball\PinUPSystem\PUPVideos\HongKongPhooey).

Table author: 
I would have been more than happy if @Hursty would have added the code to his next release as a sort of backport. My edits are trivial and most of them were blatantly taken from @NailBuster's code. However, I couldn't get Hursty's blessing to add the code or be allowed to release my minor code changes as a mod. Hursty said that he wanted to create a pup-pack of his own with actual triggers from game play, although that is a hard task for an EM table..

Script Options:
For PUP-pack video playback I had to silence the music that  comes with Hursty's original table. You can find that toggle easily in the table script: look for

PlaySong   = 1      ' 0=pup and music off, 1=enable Pinup Player functions for this table, 2=play music only

and edit accordingly.

I hope that some will find this PUP-pack fun and apologize for the long read. 

Enjoy

Joachim aka GauGau