Updating the Master List: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
m (fixed script)
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''Note: The Game and Animation Master List are no longer used, this is a legacy guide.'''
This page describes how to use Flashpoint's database file to export and update the Game Master List and Animation Master List.
This page describes how to use Flashpoint's database file to export and update the Game Master List and Animation Master List.


First, download the [http://infinity.unstable.life/Flashpoint/Data/flashpoint.sqlite latest Flashpoint database file] if you don't have it already.
First, download the [http://infinity.unstable.life/Flashpoint/Data/flashpoint.sqlite latest Flashpoint database file] if you don't have it already.
'''As of Version 12, the database file now lives [https://gitlab.unstable.life/flashpoint/components/core/Database on Gitlab].'''


== Exporting CSV Files ==
== Exporting CSV Files ==
Line 8: Line 12:
# Download, install and open [https://sqlitebrowser.org/ DB Browser for SQLite].
# Download, install and open [https://sqlitebrowser.org/ DB Browser for SQLite].
# Open the <code>flashpoint.sqlite</code> file (<code>File -> Open Database...</code>)
# Open the <code>flashpoint.sqlite</code> file (<code>File -> Open Database...</code>)
# Click <code>File -> Export -> Table(s) to CSV file...</code>
# Open the <code>Execute SQL</code> tab and use the following: <pre>SELECT id, title, developer, publisher, REPLACE(platformsStr, "; HTML5", "") AS platform FROM game WHERE library = "arcade";</pre>
# Select the <code>game</code> table and leave all other options at their default values. Save the file.
Change <code>arcade</code> to <code>theatre</code> if you intend to update the Animation Master List instead. Execute the command and save the view as a CSV file.
 
== Adding a Platform to the Game Request Form ==
 
The first step to adding a platform to the Game Request Form is, of course, to add the option to the relevant question on the form. But there are a few more necessary steps:
# Open the [https://docs.google.com/spreadsheets/d/1JfxEL5PxoOz9r-cz-2ivdvooscQrX6uuhbV_Na2xGss/edit#gid=475519150 Platforms tab of the Game Master List spreadsheet].
# Scroll down to the first empty row.
# Add the Platform name to column A, exactly as it appears in the arcade.csv file.
# Add the corresponding Platform name from the Game Request Form to column B, exactly as it appears on the Game Request Form.
 
'''Important Notes''':
* These steps are only necessary if the option name on the Game Request Form corresponding to this Platform differs from the actual Platform name in Flashpoint. For example, the option name for the "Flash" platform is "Flash Player", so "Flash" goes in column A and "Flash Player" goes in column B.
* These steps ''must'' be performed '''before''' updating the Master List sheets!
* The steps for updating the Animation Request Form are the same, except that you need to use the [https://docs.google.com/spreadsheets/d/1aCGXBPwueSU_MVXD_-MF2GryGod0BThw5xSoHJR7eBQ/edit#gid=1026610466 Animation Master List] spreadsheet instead.
 
== Updating the Google Sheets ==
 
=== Updating the Game Master List Sheet ===
 
To update the [https://docs.google.com/spreadsheets/d/1JfxEL5PxoOz9r-cz-2ivdvooscQrX6uuhbV_Na2xGss/edit Game Master List sheet]:
# Select the entire header bar (first row of the sheet). Click Ctrl-C to copy it.
# Click File => Import.
# Click the Upload tab and select the arcade.csv file.
# Click the "Import location" dropdown and select "Replace current sheet". Uncheck "Convert text to numbers, dates, and formulas".
#* '''Do not select "Replace spreadsheet"! That will delete all the other tabs of the spreadsheet! Double-check that you've selected the correct option before you continue!'''
# Click "Import data" and wait a bit for the new data to appear.
# Delete the Series column by selecting it and clicking Edit => Delete => Column.
# Select the header bar and paste in the headings that you copied in Step 1. The formatting of the header bar should now be restored.
# Delete any empty columns on the right and any empty rows at the bottom. Resize columns to your liking.
 
Once that is done, click the "Game & Platform Only" tab of the spreadsheet. It will be mostly empty, with two <code>#REF!</code> errors near the top. To fix these errors:
# Click one of the errors to get more information. The error message will indicate how many rows need to be added to the sheet. Copy that number.
# Scroll all the way down to the bottom of the sheet. Paste the number into the "Add more rows at the bottom" box.
# Click the "Add" button. Wait a few moments, and the sheet will be fixed!
 
=== Updating the Game Requests Sheet ===


Next, follow these steps to create separate game and animation CSV files:
Now that the main master list sheet has been updated, those changes need to be copied to the game requests spreadsheet. We will do this by exporting the data as CSV, then importing it into the other sheet:
# Download and run [https://www.nirsoft.net/utils/csv_file_view.html CSVFileView].
# On the "Game & Platform Only" tab of the Game Master List sheet, click File => Download => Comma Separated Values (.csv).
# Open the CSV file that you exported.
# Open the [https://docs.google.com/spreadsheets/d/1t0MbYMGm4dq4d5hA1l6MKuVYGyw9XU8UOPHjy2ceHX8/edit#gid=1973018739 Game Master List tab of the Flashpoint Game Requests spreadsheet].
# In the Options menu, change the "Unicode/Ascii Default Open Mode" to UTF-8. Then change the "Unicode/Ascii Save Mode" to "Always UTF-8."
# Click File => Import.
# In the Options menu, check "Add header line to CSV/Tab-Delimited File." Then check the "Allow MultiLine Fields" option.
# Click the Upload tab and select the downloaded CSV file.
# Click the Refresh button to reload the file.
# Click the "Import location" dropdown and select "Replace current sheet". Uncheck "Convert text to numbers, dates, and formulas".
# Click <code>View -> Edit Display Filter</code>. Check "Use the following display filter", then type one of the following:
#* '''Do not select "Replace spreadsheet"! That will delete all the other tabs of the spreadsheet! Double-check that you've selected the correct option before you continue!'''
#* <code>library = 'arcade'</code> for the Game Master List
# Click "Import data" and wait a bit for the new data to appear.
#* <code>library = 'theatre'</code> for the Animation Master List
# Delete the header row at the top of the sheet: right-click the top-left cell, then click "Delete row".
# Click <code>View -> Choose Columns</code> and check only these columns: id, title, series, developer, publisher, platform.
# Scroll down to the bottom of the sheet and delete any empty rows. Delete any empty columns on the right.
# Click <code>File -> Save All Items</code>. Save as the CSV file type.


Alternatively, use the following batch script to export the game and animation CSV files automatically:
=== Updating the Animations spreadsheets ===
<pre>
@ECHO off
SET cols="id,title,series,developer,publisher,platform"
SET baseopts=/AsciiUnicodeMode 3 /AsciiUnicodeOpenMode 3 /AddExportHeaderLine 1 /AllowMultiLineFields 1 /UseLoadFilter 1


CSVFileView /Columns %cols% %baseopts% /LoadFilterStr "library = 'arcade'" /aload %1 /scomma arcade.csv
The steps for updating the [https://docs.google.com/spreadsheets/d/1aCGXBPwueSU_MVXD_-MF2GryGod0BThw5xSoHJR7eBQ/edit Animation Master List] and [https://docs.google.com/spreadsheets/d/1EqBmxtNnNAupmGBoY35fy5ngEaZzPFIRuHJmNssA04s/edit Animation Requests] sheets are the same as their respective Games sheets. Refer to the instructions above.
CSVFileView /Columns %cols% %baseopts% /LoadFilterStr "library = 'theatre'" /aload %1 /scomma theatre.csv
</pre>
To run the script, place it in the same folder as CSVFileView, then run <code>exportMasterLists.bat sourceCSVPath</code> from the command line.


<noinclude>[[Category:Meta]]</noinclude>
<noinclude>[[Category:Meta]]</noinclude>
<noinclude>[[Category:Legacy articles]]</noinclude>

Latest revision as of 00:02, 16 February 2024

Note: The Game and Animation Master List are no longer used, this is a legacy guide.

This page describes how to use Flashpoint's database file to export and update the Game Master List and Animation Master List.

First, download the latest Flashpoint database file if you don't have it already.

As of Version 12, the database file now lives on Gitlab.

Exporting CSV Files

Follow these steps to export the entire game/animation database as a CSV file:

  1. Download, install and open DB Browser for SQLite.
  2. Open the flashpoint.sqlite file (File -> Open Database...)
  3. Open the Execute SQL tab and use the following:
    SELECT id, title, developer, publisher, REPLACE(platformsStr, "; HTML5", "") AS platform FROM game WHERE library = "arcade";

Change arcade to theatre if you intend to update the Animation Master List instead. Execute the command and save the view as a CSV file.

Adding a Platform to the Game Request Form

The first step to adding a platform to the Game Request Form is, of course, to add the option to the relevant question on the form. But there are a few more necessary steps:

  1. Open the Platforms tab of the Game Master List spreadsheet.
  2. Scroll down to the first empty row.
  3. Add the Platform name to column A, exactly as it appears in the arcade.csv file.
  4. Add the corresponding Platform name from the Game Request Form to column B, exactly as it appears on the Game Request Form.

Important Notes:

  • These steps are only necessary if the option name on the Game Request Form corresponding to this Platform differs from the actual Platform name in Flashpoint. For example, the option name for the "Flash" platform is "Flash Player", so "Flash" goes in column A and "Flash Player" goes in column B.
  • These steps must be performed before updating the Master List sheets!
  • The steps for updating the Animation Request Form are the same, except that you need to use the Animation Master List spreadsheet instead.

Updating the Google Sheets

Updating the Game Master List Sheet

To update the Game Master List sheet:

  1. Select the entire header bar (first row of the sheet). Click Ctrl-C to copy it.
  2. Click File => Import.
  3. Click the Upload tab and select the arcade.csv file.
  4. Click the "Import location" dropdown and select "Replace current sheet". Uncheck "Convert text to numbers, dates, and formulas".
    • Do not select "Replace spreadsheet"! That will delete all the other tabs of the spreadsheet! Double-check that you've selected the correct option before you continue!
  5. Click "Import data" and wait a bit for the new data to appear.
  6. Delete the Series column by selecting it and clicking Edit => Delete => Column.
  7. Select the header bar and paste in the headings that you copied in Step 1. The formatting of the header bar should now be restored.
  8. Delete any empty columns on the right and any empty rows at the bottom. Resize columns to your liking.

Once that is done, click the "Game & Platform Only" tab of the spreadsheet. It will be mostly empty, with two #REF! errors near the top. To fix these errors:

  1. Click one of the errors to get more information. The error message will indicate how many rows need to be added to the sheet. Copy that number.
  2. Scroll all the way down to the bottom of the sheet. Paste the number into the "Add more rows at the bottom" box.
  3. Click the "Add" button. Wait a few moments, and the sheet will be fixed!

Updating the Game Requests Sheet

Now that the main master list sheet has been updated, those changes need to be copied to the game requests spreadsheet. We will do this by exporting the data as CSV, then importing it into the other sheet:

  1. On the "Game & Platform Only" tab of the Game Master List sheet, click File => Download => Comma Separated Values (.csv).
  2. Open the Game Master List tab of the Flashpoint Game Requests spreadsheet.
  3. Click File => Import.
  4. Click the Upload tab and select the downloaded CSV file.
  5. Click the "Import location" dropdown and select "Replace current sheet". Uncheck "Convert text to numbers, dates, and formulas".
    • Do not select "Replace spreadsheet"! That will delete all the other tabs of the spreadsheet! Double-check that you've selected the correct option before you continue!
  6. Click "Import data" and wait a bit for the new data to appear.
  7. Delete the header row at the top of the sheet: right-click the top-left cell, then click "Delete row".
  8. Scroll down to the bottom of the sheet and delete any empty rows. Delete any empty columns on the right.

Updating the Animations spreadsheets

The steps for updating the Animation Master List and Animation Requests sheets are the same as their respective Games sheets. Refer to the instructions above.