Metadata Edits: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
(Added info about adding Extras)
(→‎Metadata Changes: launch command and application path clarification)
 
(56 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[File:Curationedits.png|thumb|Shows how to find the ID of a game in Flashpoint Launcher.]]
[[File:editgamefpfssmenu.png|thumb|With the Edit Game (FPFSS) menu, metadata can be changed entirely in-browser.]]
This page describes how to submit metadata changes to games or animations that are already in Flashpoint.
This page describes how to submit metadata changes to games or animations that are already in Flashpoint.
BlueMaxima will use [https://github.com/afrmtbl/flashpoint-devtools this tool] to make these changes. If you would like to test whether your text file works, follow the instructions on that page to install and use the tool.


First, use your copy of Flashpoint to find the ID of the game/animation that you wish to change.
Before you begin, please note that metadata edits can only be submitted for games that are already in Flashpoint. If you notice a mistake with your own curation after you've submitted it, you should upload a fixed version with the changes made on your curation's page before it is marked as added to Flashpoint. Once marked, you can now submit a metadata edit.
# Click the entry to select it.
# On the right sidebar, click the pencil button. If this button is not available, click the Config tab of the launcher and check the Enable Editing box.
# Copy the ID shown. An example is shown on the right.


Next, create a text file using this ID. The text file should specify the new value for each field you would like to update. The example below will change the Developer and Publisher of the entry for Elephant Quest.
== Metadata Changes ==
GAME 1e2f9810-f19f-4caa-bedb-1124ab04a630
Developer: Armor Games, jmtb02, Jimp
Publisher: Armor Games


You can also specify more than one game in this text file. This enables batch-editing. The example below will update the entries for Elephant Quest, Sushi Cat, and Sushi Cat 4: The Honeymoon.
Metadata edits are done entirely in the latest installer version of Flashpoint.
GAME 1e2f9810-f19f-4caa-bedb-1124ab04a630
Developer: Armor Games, jmtb02, Jimp
Publisher: Armor Games
GAME 59041e00-c77d-4cc1-a00e-5a1161d84cea
Developer: Armor Games, JoeyBetz, Jimp
Series: Sushi Cat
GAME 35b1a44e-6356-00ef-6e51-d38dbb77dc6b
Developer: Armor Games, JoeyBetz, Jimp
Series: Sushi Cat


If your metadata edit is short, you may paste it directly into a Discord message if you wish, rather than uploading a text file.
'''Metadata editing is currently restricted to Staff and Trial Editors only.'''


== Submitting Alternates ==
First make sure Editing is enabled in the Config menu. At the top of the sidebar for every game is the Edit Game (FPFSS) button, click it to begin editing. If you are not logged into the launcher with your Discord account,  it will open FPFSS in your internet browser asking if you approve the device. Approve it and head back to the launcher. The metadata editing menu will now be open.


In addition to metadata changes for existing games, it is possible to submit alternate versions of games that are already in Flashpoint. Alternates are listed on the right sidebar of Flashpoint Launcher when a game is selected. Although the format of an alternate submission is similar to that of a metadata edit, BlueMaxima adds alternates manually. So, be sure to indicate the title of the game in your submission to make the process easier.
[[File:editgamefpfssbutton.png|none|frameless|border]]


To submit an alternate, upload or link to a ZIP file containing the game files, in the same format as the <code>content</code> folder of a standard curation. If any other files are required (such as a Shockwave Xtra), include those as well. If you would like to submit Extras for an existing game, just include an Extras folder in your ZIP file. In your message, include the name of game entry to be modified. If applicable, include additional instructions for BlueMaxima, such as whether existing files in Flashpoint should be moved or copied. Although the format isn't strict, here is an example of what your message should look like:
Here you can edit every single aspect of an entry's metadata, except for GameZIP application path and launch commands. Those edits are done on the <code>https://fpfss.unstable.life/web/game/(UUID)</code> link of a zipped title. Additional Applications can also be added via this method, but if they require any edits to the game files, then again they need to be content patches. '''Please follow the [[Curation Format|curation formatting rules]].'''


  Add old version of WONKAir Hockey with better-quality sound
When you are ready to submit your edits, click the check icon, and after a few seconds a small window should let you know if it was a success or a failure. If it was a failure, then close and reopen the launcher and try again. If you forgot to include an edit, open the menu and re-edit it. There are no limits to how many times you can edit an entry.
  https://cdn.discordapp.com/attachments/432709773213827083/570272874317873167/lbgdev.biz.zip
 
GAME 72da4e3d-689e-493f-855c-995d943d210e
== Submitting Logos/Screenshots ==
Additional Applications:
 
    Message: If I wanted to make a message pop up before the game runs, I could add it this way.
Add any new logos or screenshots into a ZIP file structured as so:
    Old Version:
 
        Heading: Play old version with better-quality sound
  Logos
        Application Path: FPSoftware\Shockwave\PJ101\SPR.exe
└─── ID.png
        Launch Command: http://wonka.com/WONKAir_Hockey.dcr
Screenshots
└─── ID.png
└─── ID.png
  └─── ID.png
 
You may submit multiple logos/screenshots in a single ZIP file, as long as they are named after the curation's ID. Replace "ID" with the UUID of the curation that you copied from the Launcher. Submit the ZIP file to [https://discord.com/channels/432708847304704010/912557422906859570 #logos-screenshots]
 
== Duplicates ==
 
First of all, if a curation requires metadata to be merged or content to be moved around/deleted, follow the appropriate steps from [[#Metadata Edits (JSONs)|Metadata Edits]] and [[Content Patches]].
 
Next, post a message with the UUID and title of the "main" curation, along with the UUIDs and titles of the duplicates to be deleted in [https://discord.com/channels/432708847304704010/912557662204481616 #duplicates]. Make sure both versions are identical, and if not then make a [[Content Patches|content patch]] adding one as an additional application to the other one. The entry with better metadata takes precendence in not being deleted.
 
<noinclude>
[[Category:Curation Guides]]
</noinclude>

Latest revision as of 16:37, 15 November 2023

With the Edit Game (FPFSS) menu, metadata can be changed entirely in-browser.

This page describes how to submit metadata changes to games or animations that are already in Flashpoint.

Before you begin, please note that metadata edits can only be submitted for games that are already in Flashpoint. If you notice a mistake with your own curation after you've submitted it, you should upload a fixed version with the changes made on your curation's page before it is marked as added to Flashpoint. Once marked, you can now submit a metadata edit.

Metadata Changes

Metadata edits are done entirely in the latest installer version of Flashpoint.

Metadata editing is currently restricted to Staff and Trial Editors only.

First make sure Editing is enabled in the Config menu. At the top of the sidebar for every game is the Edit Game (FPFSS) button, click it to begin editing. If you are not logged into the launcher with your Discord account, it will open FPFSS in your internet browser asking if you approve the device. Approve it and head back to the launcher. The metadata editing menu will now be open.

Editgamefpfssbutton.png

Here you can edit every single aspect of an entry's metadata, except for GameZIP application path and launch commands. Those edits are done on the https://fpfss.unstable.life/web/game/(UUID) link of a zipped title. Additional Applications can also be added via this method, but if they require any edits to the game files, then again they need to be content patches. Please follow the curation formatting rules.

When you are ready to submit your edits, click the check icon, and after a few seconds a small window should let you know if it was a success or a failure. If it was a failure, then close and reopen the launcher and try again. If you forgot to include an edit, open the menu and re-edit it. There are no limits to how many times you can edit an entry.

Submitting Logos/Screenshots

Add any new logos or screenshots into a ZIP file structured as so: 

Logos
└─── ID.png
Screenshots
└─── ID.png
└─── ID.png
└─── ID.png

You may submit multiple logos/screenshots in a single ZIP file, as long as they are named after the curation's ID. Replace "ID" with the UUID of the curation that you copied from the Launcher. Submit the ZIP file to #logos-screenshots

Duplicates

First of all, if a curation requires metadata to be merged or content to be moved around/deleted, follow the appropriate steps from Metadata Edits and Content Patches.

Next, post a message with the UUID and title of the "main" curation, along with the UUIDs and titles of the duplicates to be deleted in #duplicates. Make sure both versions are identical, and if not then make a content patch adding one as an additional application to the other one. The entry with better metadata takes precendence in not being deleted.

Retrieved from "https://flashpointarchive.org/w/index.php?title=Metadata_Edits&oldid=9794"