Old Zipping Guide: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
This page describes how to create and test GameZIPs. The goal is to create GameZIPs for existing Legacy games, allowing the ZIP to replace the existing game files in <code>Legacy\htdocs</code>. You'll need a copy of Flashpoint Core, as well as a copy of either Flashpoint Infinity or Ultimate.
This page describes how to create and test GameZIPs. The goal is to create GameZIPs for existing Legacy games, allowing the ZIP to replace the existing game files in <code>Legacy\htdocs</code>. You will need a copy of Flashpoint Core.


== Creating a GameZIP ==
== Creating a GameZIP ==
Line 5: Line 5:
=== Setting it Up ===
=== Setting it Up ===


# Find the '''Utilities''' folder in your copy of Flashpoint Core. Copy it into the same location in Flashpoint Infinity or Ultimate.
To set up your copy of Flashpoint Core, open the Data folder and back up the <code>flashpoint.sqlite</code> file. (You can rename it to something like flashpoint.sqlite.bak, for example.) Then replace Core's flashpoint.sqlite file with the one from your copy of Infinity/Ultimate, or [http://infinity.unstable.life/Flashpoint/Data/flashpoint.sqlite download a fresh database file]. You then normally should see the same list of games you see in Infinity/Ultimate when launching Core.
# Open Flashpoint Infinity or Ultimate and find the game that you'd like to convert. Right-click the game and copy its UUID.
# Create a new folder and name it according to the UUID you just copied.
#* '''Note:''' Do ''not'' create a "content" folder inside this folder!


=== Gathering the Files ===
Next download the [https://bluepload.unstable.life/win-unpacked18.7z latest Launcher build for Core], extract and then copy everything to your copy of Core. This will replace many files.
 
Finally go to the Legacy folder, open <code>router_base_urls.txt</code>, and replace the first line with: <code>Dri0m <nowiki>http://infinity.unstable.life/Flashpoint/Legacy/htdocs</nowiki></code>
 
=== Making a GameZIP ===


There are a number of approaches for finding files for your zip. You might want to use some combination of the approaches below:
To make a GameZIP of a legacy game, search it in Core, right-click it and then select <code>Make Curation from Game</code>. Gather the files of the game and put them in the content folder of the curation you newly created in the exact same way as if you were making a curation, ie. the files need to be in their correct folders inside the content one.
* Launch the game in Flashpoint and check the Logs tab. Make a note of which files the game loads and where they are located. Find and copy these files into the UUID folder you created earlier.
* [[Downloading Curations|Find and download the game's original curation]]. Ensure that curation's files and file locations match those in your copy of Infinity/Ultimate. You'll probably need to launch the game and check the Logs tab to find those file locations. Copy the files from the curation into your UUID folder.
** '''Note:''' The game files/folders should be located ''directly inside'' the UUID folder! There should not be a "content" folder.


Once you've gathered the files, you may want to open your copy of Flashpoint Core and create a new curation just to quickly test that you didn't miss any files. Be sure to [[Extended_FAQ#ClearWinINetCache|clear your cache]] before testing!
After doing that, you can simply click on <code>Export Data Pack</code> to get a GameZIP and find them at the default location <code>Curations\Exported\Data Packs</code>.


=== Zipping up the Files ===
=== Gathering the Files ===


# Open the Utilities folder in Flashpoint Infinity/Ultimate (the one you copied in earlier). Open the "bluezip" folder.  
There are a number of approaches for finding the files for your zip. You might want to use some combination of the approaches below:
# Copy and paste your UUID folder containing the game files into the "bluezip" folder.  
* Launch the game in Core and check the Logs tab. Make a note of which files the game loads and where they are located. Find and copy these files into the content folder. You can right-click the game after launching it and select <code>Open File Location</code> to directly get to its files.
#* '''Note:''' The game files/folders should be located ''directly inside'' the UUID folder! There should not be a "content" folder.
* [[Downloading Curations|Find and download the game's original curation]]. Ensure that curation's files and file locations match those in your modified copy of Core. You'll probably need to launch the game and check the Logs tab to find those file locations. Copy the files from the curation into your content folder.
# Drag the UUID folder onto "_CONVERT.bat". You should see some output showing that the conversion was successful. If it asks you whether to delete files, just press Enter to skip that. Then press Enter to close the Command Prompt window.
* Go on the Flashpoint Ultimate index and download directly all the files you need from there. To get access to it, refer to the "Updater Data" section of the Staff Onboarding document. If you're zipping a multiasset game this is a very useful method to verify you have all the files, in particular if the multiasset game doesn't load all its files when launching.
# In your main Flashpoint Infinity/Ultimate folder, you should now see a Games folder. Open that folder and verify that a ZIP file named according the game's UUID has been created.
 
Once you've gathered the files, you may want to run the new curation just to quickly test that you didn't miss any files. Be sure to [[Extended_FAQ#ClearWinINetCache|clear your cache]] before testing!


== Testing a GameZIP ==
== Testing a GameZIP ==
Line 31: Line 30:
Below are instructions for testing your own GameZIP after creating it, or testing someone else's GameZIP to verify that it works.
Below are instructions for testing your own GameZIP after creating it, or testing someone else's GameZIP to verify that it works.


=== Setting it Up ===
For setting Core up, follow the same instructions in [[Zipping Guide#Setting it Up|Setting it Up]].
 
Testing should be done in '''Flashpoint Core'''. To set up your copy of Core, open the Data folder and back up the <code>flashpoint.sqlite</code> file. (You can rename it to something like flashpoint.sqlite.bak, for example.) Then replace Core's flashpoint.sqlite file with the one from your copy of Infinity/Ultimate, or [http://infinity.unstable.life/Flashpoint/Data/flashpoint.sqlite download a fresh database file].


=== Importing the GameZIP ===
=== Importing the GameZIP ===
Line 39: Line 36:
# Open your modified copy of Core. You should see the same list of games you normally see in Infinity/Ultimate.
# Open your modified copy of Core. You should see the same list of games you normally see in Infinity/Ultimate.
# Find the game corresponding to your GameZIP. You can search for <code>id:TheUUID</code> to find the right entry quickly. (Replace <code>TheUUID</code> with the game's UUID.)
# Find the game corresponding to your GameZIP. You can search for <code>id:TheUUID</code> to find the right entry quickly. (Replace <code>TheUUID</code> with the game's UUID.)
# Select the game and click "Open Game Data Browser" on the right-hand side of the launcher.
# Select the game and click <code>Open Game Data Browser</code> on the right-hand side of the launcher.
# Click the "Import Data" button. Select your ZIP file and close the Game Data Browser.
# Click the <code>Import Data</code> button. Select your ZIP file and close the Game Data Browser.


=== Testing the GameZIP ===
=== Testing the GameZIP ===


# [[Extended_FAQ#ClearWinINetCache|Clear your cache]] to ensure that cached files don't interfere with the test.
# [[Extended_FAQ#ClearWinINetCache|Clear your cache]] to ensure that cached files don't interfere with the test.
# Click "Play" to launch and test the game!
# Click <code>Play</code> to launch and test the game!

Revision as of 13:24, 13 August 2022

This page describes how to create and test GameZIPs. The goal is to create GameZIPs for existing Legacy games, allowing the ZIP to replace the existing game files in Legacy\htdocs. You will need a copy of Flashpoint Core.

Creating a GameZIP

Setting it Up

To set up your copy of Flashpoint Core, open the Data folder and back up the flashpoint.sqlite file. (You can rename it to something like flashpoint.sqlite.bak, for example.) Then replace Core's flashpoint.sqlite file with the one from your copy of Infinity/Ultimate, or download a fresh database file. You then normally should see the same list of games you see in Infinity/Ultimate when launching Core.

Next download the latest Launcher build for Core, extract and then copy everything to your copy of Core. This will replace many files.

Finally go to the Legacy folder, open router_base_urls.txt, and replace the first line with: Dri0m http://infinity.unstable.life/Flashpoint/Legacy/htdocs

Making a GameZIP

To make a GameZIP of a legacy game, search it in Core, right-click it and then select Make Curation from Game. Gather the files of the game and put them in the content folder of the curation you newly created in the exact same way as if you were making a curation, ie. the files need to be in their correct folders inside the content one.

After doing that, you can simply click on Export Data Pack to get a GameZIP and find them at the default location Curations\Exported\Data Packs.

Gathering the Files

There are a number of approaches for finding the files for your zip. You might want to use some combination of the approaches below:

  • Launch the game in Core and check the Logs tab. Make a note of which files the game loads and where they are located. Find and copy these files into the content folder. You can right-click the game after launching it and select Open File Location to directly get to its files.
  • Find and download the game's original curation. Ensure that curation's files and file locations match those in your modified copy of Core. You'll probably need to launch the game and check the Logs tab to find those file locations. Copy the files from the curation into your content folder.
  • Go on the Flashpoint Ultimate index and download directly all the files you need from there. To get access to it, refer to the "Updater Data" section of the Staff Onboarding document. If you're zipping a multiasset game this is a very useful method to verify you have all the files, in particular if the multiasset game doesn't load all its files when launching.

Once you've gathered the files, you may want to run the new curation just to quickly test that you didn't miss any files. Be sure to clear your cache before testing!

Testing a GameZIP

Below are instructions for testing your own GameZIP after creating it, or testing someone else's GameZIP to verify that it works.

For setting Core up, follow the same instructions in Setting it Up.

Importing the GameZIP

  1. Open your modified copy of Core. You should see the same list of games you normally see in Infinity/Ultimate.
  2. Find the game corresponding to your GameZIP. You can search for id:TheUUID to find the right entry quickly. (Replace TheUUID with the game's UUID.)
  3. Select the game and click Open Game Data Browser on the right-hand side of the launcher.
  4. Click the Import Data button. Select your ZIP file and close the Game Data Browser.

Testing the GameZIP

  1. Clear your cache to ensure that cached files don't interfere with the test.
  2. Click Play to launch and test the game!