Difference between revisions of "Engine:PopCap Games Framework"
From PCGamingWiki, the wiki about fixing PC games
Lolhacksrule (talk | contribs) m (Add other info) |
Lolhacksrule (talk | contribs) m (→Debug keys: Add) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
|website=https://sourceforge.net/projects/popcapframework/ | |website=https://sourceforge.net/projects/popcapframework/ | ||
|first release=2001 | |first release=2001 | ||
| − | |latest release=2009 | + | |latest release=1.30 (2009) / Present (Private) |
|wikipedia=PopCap_Games#PopCap_Games_Framework | |wikipedia=PopCap_Games#PopCap_Games_Framework | ||
|listgames=false | |listgames=false | ||
}} | }} | ||
| − | |||
'''Key points''' | '''Key points''' | ||
| − | {{ii}} Open source 2D and 3D game engine, | + | {{ii}} Open source 2D and 3D game engine up to version 1.30, closed-source forks were also made before that version for Bookworm Adventures, Bejeweled Twist and Zuma's Revenge, before being universally ready for multiplatform support and being called '''Prime'''. See [[#Games|Games]]. |
==Other information== | ==Other information== | ||
===[[Command line arguments]]=== | ===[[Command line arguments]]=== | ||
{{Help|Commandline}} | {{Help|Commandline}} | ||
| − | {{ii}} Games accept a default set of command line arguments documented [https://tcrf.net/User:LolHacksRule/PopCap_Games#Command_Line_Parameters | + | {{ii}} Games accept a default set of command line arguments documented <ref>[https://tcrf.net/User:LolHacksRule/PopCap_Games#Command_Line_Parameters PopCap Framework Command Line Arguments]</ref>. These can be used to define the content directory, force Direct3D 8 and more. |
| − | {{ii}} Keep in mind that, depending on the engine revision and operating system, some options might not be supported. | + | {{ii}} Parameters that allow you to define strings must use "=" to contain your string (including spaces) after the parameter name as a space on it's own will be read as a seperate command. |
| − | ===Debug | + | {{ii}} Keep in mind that, depending on the engine revision, game and operating system, some options might not be supported. |
| − | {{ii}} Games accept a default set of keys | + | |
| + | {{Standard table|Parameter|Description|content= | ||
| + | {{Standard table/row|-crash|Simulates an application crash with an Access Violation error instead of starting.}} | ||
| + | {{Standard table/row|-version|Display version information of the application in a window instead of starting.}} | ||
| + | {{Standard table/row|-demofile|Overrides the name and path of the demo (DMO) file for recording or playback. Removed in Bejeweled 3/Prime.}} | ||
| + | {{Standard table/row|-play|Plays the demo (DMO) file. Removed in Bejeweled 3/Prime.}} | ||
| + | {{Standard table/row|-record|Records the game session to a ''popcap.dmo'' file in the application's save data folder. Removed in Bejeweled 3/Prime.}} | ||
| + | {{Standard table/row|-recnum|Same as -record but with an increasing number appended to their name per recording.}} | ||
| + | {{Standard table/row|-playnum|Play the last saved numbered demo file. Removed in Bejeweled 3/Prime.}} | ||
| + | {{Standard table/row|-screensaver|Makes the application act like it's a screensaver, any movement or key press will immediately force close the application.}} | ||
| + | {{Standard table/row|-changedir|Changes the content directory of the game.}} | ||
| + | {{Standard table/row|-nod3d9|Forces the application to use the Direct3D 8 API over the Direct3D 9 one. Added in Bejeweled Twist/+ and not Plants vs. Zombies.}} | ||
| + | {{Standard table/row|-minidump|Writes a minidump after a crash occurs. Debug engine builds only. Added in Bejeweled Twist/+ and not Plants vs. Zombies.}} | ||
| + | {{Standard table/row|-ultradump|Writes a ultradump after a crash occurs. Debug engine builds only. Added in Bejeweled Twist/+ and not Plants vs. Zombies.}} | ||
| + | }} | ||
| + | |||
| + | ===Debug Keys=== | ||
| + | {{ii}} Games accept a default set of keys <ref>[https://tcrf.net/User:LolHacksRule/PopCap_Games#Debug_Keys PopCap Framework Debug Keys]</ref>. These can be used to dump a screenshot, dump application images, show video stats and more. | ||
{{ii}} Keep in mind that, depending on the engine revision and operating system, some options might not be supported. | {{ii}} Keep in mind that, depending on the engine revision and operating system, some options might not be supported. | ||
| + | {{ii}} Most require CTRL+ALT+D to be pressed during a session to enable them, a sound will play if done. | ||
| + | |||
| + | {{Standard table|Key/Combo|Description|content= | ||
| + | {{Standard table/row|F1|Toggles visibility of game build information. The second press will move it to the top of the application screen and the last one hides it. Does not require debug keys.}} | ||
| + | {{Standard table/row|F2|Records performance timing, another use ends it and displays a window with the total time of the duration and function info.}} | ||
| + | {{Standard table/row|SHIFT-F2|Displays '''PERF RECORDING''' in red and another use dumps the data to '''%USERPROFILE%\AppData\Local\Temp\smstemp*''' and runs SpikeMonkey to load it which is probably an internal tool to parse it.}} | ||
| + | {{Standard table/row|F3|Toggles visibility of the FPS display. When displayed during demo playback it will also display the demo duration.}} | ||
| + | {{Standard table/row|CTRL+F3|Display a window for the frame overdraw.}} | ||
| + | {{Standard table/row|SHIFT+F3|Toggle between the standard FPS display, FPS display with historical graph (Bejeweled Blitz and onward) or mouse coordinates. In the historical graph, green shows roughly standard performance, yellow shows spikes, and red shows major spikes.}} | ||
| + | {{Standard table/row|F8|Displays video stats, in older versions, toggles 3D-Acceleration.}} | ||
| + | {{Standard table/row|SHIFT+F8|Toggle 3D-Acceleration.}} | ||
| + | {{Standard table/row|Alt+F8|Toggle VSync. Added in Bejeweled Twist and onward and not Plants vs. Zombies.}} | ||
| + | {{Standard table/row|F10|Enables single stepping, another use advances one frame.}} | ||
| + | {{Standard table/row|SHIFT+F10|Disables single stepping to restore the original framerate.}} | ||
| + | {{Standard table/row|CTRL+F10|Toggles slow motion (25FPS cap), Only on Windows and usually debug or beta engine builds.}} | ||
| + | {{Standard table/row|F11|Dumps a screenshot of the game window in the ''_screenshots'' directory of the application's user data folder. Removed in Bejeweled Blitz and onward}} | ||
| + | {{Standard table/row|SHIFT+F11|Dumps all application images in the ''_dump'' directory of the application's user data folder. Removed in Bejeweled 3 and onward}} | ||
| + | {{Standard table/row|F12|Forces a breakpoint in the debugger.}} | ||
| + | {{Standard table/row|ALT+R|Reparses modvals, displays a window regarding source code changes. Only on Windows and usually debug or beta engine builds.}} | ||
| + | }} | ||
==Games== | ==Games== | ||
{{Infobox engine/query}} | {{Infobox engine/query}} | ||
Latest revision as of 19:49, 11 June 2024
| Developers | |
|---|---|
| PopCap Games | |
| Website | |
| https://sourceforge.net/projects/popcapframework/ | |
| First release date | |
| 2001 | |
| Latest release date | |
| 1.30 (2009) / Present (Private) | |
Key points
- Open source 2D and 3D game engine up to version 1.30, closed-source forks were also made before that version for Bookworm Adventures, Bejeweled Twist and Zuma's Revenge, before being universally ready for multiplatform support and being called Prime. See Games.
Other information
Command line arguments
- See command line arguments on how to use the following options.
- Games accept a default set of command line arguments documented [1]. These can be used to define the content directory, force Direct3D 8 and more.
- Parameters that allow you to define strings must use "=" to contain your string (including spaces) after the parameter name as a space on it's own will be read as a seperate command.
- Keep in mind that, depending on the engine revision, game and operating system, some options might not be supported.
| Parameter | Description |
|---|---|
| -crash | Simulates an application crash with an Access Violation error instead of starting. |
| -version | Display version information of the application in a window instead of starting. |
| -demofile | Overrides the name and path of the demo (DMO) file for recording or playback. Removed in Bejeweled 3/Prime. |
| -play | Plays the demo (DMO) file. Removed in Bejeweled 3/Prime. |
| -record | Records the game session to a popcap.dmo file in the application's save data folder. Removed in Bejeweled 3/Prime. |
| -recnum | Same as -record but with an increasing number appended to their name per recording. |
| -playnum | Play the last saved numbered demo file. Removed in Bejeweled 3/Prime. |
| -screensaver | Makes the application act like it's a screensaver, any movement or key press will immediately force close the application. |
| -changedir | Changes the content directory of the game. |
| -nod3d9 | Forces the application to use the Direct3D 8 API over the Direct3D 9 one. Added in Bejeweled Twist/+ and not Plants vs. Zombies. |
| -minidump | Writes a minidump after a crash occurs. Debug engine builds only. Added in Bejeweled Twist/+ and not Plants vs. Zombies. |
| -ultradump | Writes a ultradump after a crash occurs. Debug engine builds only. Added in Bejeweled Twist/+ and not Plants vs. Zombies. |
Debug Keys
- Games accept a default set of keys [2]. These can be used to dump a screenshot, dump application images, show video stats and more.
- Keep in mind that, depending on the engine revision and operating system, some options might not be supported.
- Most require CTRL+ALT+D to be pressed during a session to enable them, a sound will play if done.
| Key/Combo | Description |
|---|---|
| F1 | Toggles visibility of game build information. The second press will move it to the top of the application screen and the last one hides it. Does not require debug keys. |
| F2 | Records performance timing, another use ends it and displays a window with the total time of the duration and function info. |
| SHIFT-F2 | Displays PERF RECORDING in red and another use dumps the data to %USERPROFILE%\AppData\Local\Temp\smstemp* and runs SpikeMonkey to load it which is probably an internal tool to parse it. |
| F3 | Toggles visibility of the FPS display. When displayed during demo playback it will also display the demo duration. |
| CTRL+F3 | Display a window for the frame overdraw. |
| SHIFT+F3 | Toggle between the standard FPS display, FPS display with historical graph (Bejeweled Blitz and onward) or mouse coordinates. In the historical graph, green shows roughly standard performance, yellow shows spikes, and red shows major spikes. |
| F8 | Displays video stats, in older versions, toggles 3D-Acceleration. |
| SHIFT+F8 | Toggle 3D-Acceleration. |
| Alt+F8 | Toggle VSync. Added in Bejeweled Twist and onward and not Plants vs. Zombies. |
| F10 | Enables single stepping, another use advances one frame. |
| SHIFT+F10 | Disables single stepping to restore the original framerate. |
| CTRL+F10 | Toggles slow motion (25FPS cap), Only on Windows and usually debug or beta engine builds. |
| F11 | Dumps a screenshot of the game window in the _screenshots directory of the application's user data folder. Removed in Bejeweled Blitz and onward |
| SHIFT+F11 | Dumps all application images in the _dump directory of the application's user data folder. Removed in Bejeweled 3 and onward |
| F12 | Forces a breakpoint in the debugger. |
| ALT+R | Reparses modvals, displays a window regarding source code changes. Only on Windows and usually debug or beta engine builds. |