D'Fusion Curation: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
This guide will show you how to curate D'Fusion using Flashpoint Core.
This guide will show you how to curate D'Fusion content using Flashpoint Core.


== Before You Start ==
== Before You Start ==
Line 9: Line 9:
* The page will ask you to install the D'Fusion web plugin.
* The page will ask you to install the D'Fusion web plugin.
* The D'Fusion plugin mainly uses .dpd and .ssc files, but it also uses a .dll and may use an .xml as well.
* The D'Fusion plugin mainly uses .dpd and .ssc files, but it also uses a .dll and may use an .xml as well.
* The D'Fusion plugin uses the MIME types <code>application/x-dfusion-web2</code>.
* The D'Fusion plugin uses the MIME types <code>application/x-dfusion-web</code>, <code>application/x-dfusion-web2</code> and <code>application/x-dfusion-web2-s64</code> for Mac.
* XMLs and other files found show gibberish when viewed.
* XMLs and other files found show gibberish when viewed.


== Curation Steps ==
== Curation Steps ==
First mirror all of the assets on the page. cURLsDownloader will usually only be able to mirror the page's Javascript files so you will need to mirror other assets by hand or compile them into a text document.
First, check the Javascript embed for D'Fusion. This Javascript embed will list all of the subdirectories used by D'Fusion (except /js/ and /plugin/). Take one of the subdirectories (preferably the one that has the .dpd) and add .update.xml to the end of the URL. This will give you a list of files in the directory and will allow the plugin to decrypt files, '''curations will not work without this'''. Follow one of the instructions below and once finished, set the application path to <code>FPSoftware\startDFusion.bat</code>. The D'Fusion plugin will usually run fine if all assets are mirrored. If a D'Fusion curation requires a marker (a PDF/image needed for some curations to start), add it as an additional app, not as an extra. This is the same case for the Mac version of a D'Fusion player, which will often have files that exceed Windows' 256 character file path limit.


After mirroring the other files seen on the page, you will often need to URL guess the rest of the assets. The rest of the game's subdirectories can be found in a JavaScript embed for the plugin. View the page source and find:
===If .update.xml is present===
<pre><div id="plugin_dfusion" align="center"></pre>
If .update.xml is present, using MAD4FP would be enough. Make sure to download .update.xmls for all folders (excluding /js/, /plugin/ and anything not used by D'Fusion like the images directory) prior to running the curation. If not, the game will either fail to initialize or MAD4FP will be unable to get the rest of the game's assets. If you did this, you would likely need to clear your cache so that the plugin would not keep using the cached files instead of trying to downloading the scenario again.
Directly below that will be the Javascript embed. The embed will often list DFusionWebPlayer/DFusionWebPlayer, this is the .dll URL, with /DFusionWebPlayer/ being the subdirectory. Similarly, a Mac version will usually exist, but in a .bundle instead. The Mac version can be added as an Extra. Names of these folders vary each curation but have generally the same file structure, so you may be able to URL guess most of the files by comparing it to previous curations.


Add .update.xml to these directories to gain a list of files in the directory. If this file is missing, it will be nearly impossible to curate the game and may indicate more missing files. There are also more required assets in the folder where the .dpd is located, add .update.xml as well to get a list of files in the directory.
===If .update.xml is not present and other situations===
If .update.xml is not present, the game is uncuratable unless the game's files are URL guessed. This can often be done by looking at previous D'Fusion curations. Once URL guessed, the game should be Flashfreezed as there is currently no way to reverse-engineer the .update.xml file to make the curation work.


Set the application path to <code>FPSoftware\startDFusion.bat</code>. The D'Fusion plugin will usually run fine if all assets are mirrored.
If the game/animation is missing at least one asset (.update.xml or something else), the game will fail to start. This is why most D'Fusion games/animations on the Wayback Machine are uncuratable. If the game/animation is still live, then the available files should be mirrored then Flashfreezed.


'''Note: The game will not start if even a single asset is missing.'''
==SATCH vs D'Fusion==
Some curations (most often Japanese) used SATCH Studio (not to be confused with the SATCH Viewer) as an authoring software instead of D'Fusion Studio. Curations made in SATCH look identical to regular D'Fusion curations except they won't load (<code>Error when loading the player, please restart the application or contact support</code>). MAD4FP will still be able to download all of the assets if .update.xml is present so it is still necessary to run the curation. The curation should then be Flashfreezed as there is currently no way to run curations which used SATCH.
 
==Clearing Scenario Cache==
To clear your D'Fusion cache, first navigate to <code>%appdata%\Total Immersion\Web\Scns\</code>. This folder contains decompiled "scenarios" from D'Fusion curations which are called upon loading the game. Delete the folder with the domain matching the curation. (Note: If curating a game on a subdomain, the folder in appdata would have the site root as the folder name, not the subdomain itself; example.com not a.example.com)
 
If your game has a splash screen, you have to navigate to <code>%appdata%\Total Immersion\Web\Splash\</code> to delete the splash screen cache of your curation.
 
To fully clear cache, you would also need to delete the decrypted player files located at <code>%appdata%\Total Immersion\Player\gen\</code>. It would depend on the curation for which version of the player you would need to delete to clear that particular curation's cache. You can check what version of D'Fusion your curation uses by opening up <code>totalimmersion_dfusion_web_plugin.js</code> in your curation.


== Wrapping It Up ==
== Wrapping It Up ==

Revision as of 16:27, 15 July 2022

This guide will show you how to curate D'Fusion content using Flashpoint Core.

Before You Start

Recognizing D'Fusion

  • The page title will usually contain "D'Fusion @Home Web Player Sample"
  • The page will ask you to install the D'Fusion web plugin.
  • The D'Fusion plugin mainly uses .dpd and .ssc files, but it also uses a .dll and may use an .xml as well.
  • The D'Fusion plugin uses the MIME types application/x-dfusion-web, application/x-dfusion-web2 and application/x-dfusion-web2-s64 for Mac.
  • XMLs and other files found show gibberish when viewed.

Curation Steps

First, check the Javascript embed for D'Fusion. This Javascript embed will list all of the subdirectories used by D'Fusion (except /js/ and /plugin/). Take one of the subdirectories (preferably the one that has the .dpd) and add .update.xml to the end of the URL. This will give you a list of files in the directory and will allow the plugin to decrypt files, curations will not work without this. Follow one of the instructions below and once finished, set the application path to FPSoftware\startDFusion.bat. The D'Fusion plugin will usually run fine if all assets are mirrored. If a D'Fusion curation requires a marker (a PDF/image needed for some curations to start), add it as an additional app, not as an extra. This is the same case for the Mac version of a D'Fusion player, which will often have files that exceed Windows' 256 character file path limit.

If .update.xml is present

If .update.xml is present, using MAD4FP would be enough. Make sure to download .update.xmls for all folders (excluding /js/, /plugin/ and anything not used by D'Fusion like the images directory) prior to running the curation. If not, the game will either fail to initialize or MAD4FP will be unable to get the rest of the game's assets. If you did this, you would likely need to clear your cache so that the plugin would not keep using the cached files instead of trying to downloading the scenario again.

If .update.xml is not present and other situations

If .update.xml is not present, the game is uncuratable unless the game's files are URL guessed. This can often be done by looking at previous D'Fusion curations. Once URL guessed, the game should be Flashfreezed as there is currently no way to reverse-engineer the .update.xml file to make the curation work.

If the game/animation is missing at least one asset (.update.xml or something else), the game will fail to start. This is why most D'Fusion games/animations on the Wayback Machine are uncuratable. If the game/animation is still live, then the available files should be mirrored then Flashfreezed.

SATCH vs D'Fusion

Some curations (most often Japanese) used SATCH Studio (not to be confused with the SATCH Viewer) as an authoring software instead of D'Fusion Studio. Curations made in SATCH look identical to regular D'Fusion curations except they won't load (Error when loading the player, please restart the application or contact support). MAD4FP will still be able to download all of the assets if .update.xml is present so it is still necessary to run the curation. The curation should then be Flashfreezed as there is currently no way to run curations which used SATCH.

Clearing Scenario Cache

To clear your D'Fusion cache, first navigate to %appdata%\Total Immersion\Web\Scns\. This folder contains decompiled "scenarios" from D'Fusion curations which are called upon loading the game. Delete the folder with the domain matching the curation. (Note: If curating a game on a subdomain, the folder in appdata would have the site root as the folder name, not the subdomain itself; example.com not a.example.com)

If your game has a splash screen, you have to navigate to %appdata%\Total Immersion\Web\Splash\ to delete the splash screen cache of your curation.

To fully clear cache, you would also need to delete the decrypted player files located at %appdata%\Total Immersion\Player\gen\. It would depend on the curation for which version of the player you would need to delete to clear that particular curation's cache. You can check what version of D'Fusion your curation uses by opening up totalimmersion_dfusion_web_plugin.js in your curation.

Wrapping It Up

First, make sure that you have thoroughly tested your curation and followed the Curation Format. Scroll down in the Curate tab and click the Export button at the bottom of your curation to save it as a .7z file. After you've exported the curation, you can find it by clicking the Exported Curations button on the Curate tab (as long as you didn't choose to save it somewhere else). Once you have the file, submit it to the Flashpoint Submission System. An explanation of how the site works is available here.

After you have uploaded your curation to the website, a Curator will check it. This can take some time, so please be patient. You will be pinged in the #fpfss-notifications channel about whether or not your submission was approved, and if any changes need to be made.

Congratulations! Your submitted game/animation will appear in a future version of Flashpoint.