Metadata Edits: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
(Added a bunch of clarifications for how the system works)
(→‎Metadata Changes: launch command and application path clarification)
 
(38 intermediate revisions by 9 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.


All metadata changes should be submitted in our #pending-fixes channel on Discord, including game/animation assets if necessary.  
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.


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 shortly after you've submitted it, you should delete and resubmit the curation instead of submitting a metadata edit.
== Metadata Changes ==


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


First, use your copy of Flashpoint Infinity or Ultimate to find the ID of the game/animation that you wish to change.
'''Metadata editing is currently restricted to Staff and Trial Editors only.'''
# 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.
If the game that you are trying to edit is not yet available in Flashpoint Infinity or Ultimate, you will need to do one of the following to find the ID of the game:
* Download [http://bluemaxima.org/flashpoint/downloads/ Flashpoint Infinity Nightly] and follow the steps above.
* Ask in the Flashpoint Discord for the ID of the game.


Once you've found the ID of the game, create a text specifying 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.
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.
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. However, before submitting batch edits, please note the following:
[[File:editgamefpfssbutton.png|none|frameless|border]]
# A batch metadata edit must only include games of one Platform. For example, you cannot submit a batch edit for both Flash and Shockwave games.
# A batch metadata edit can include games or animations, but not both.


The example below will update the entries for Elephant Quest, Sushi Cat, and Sushi Cat 4: The Honeymoon.
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]].'''
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.
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.


Before you submit your metadata edit, be sure to add a descriptive label at the top of your message. For example, you might add a line that says "Update metadata for Elephant Quest, Sushi Cat, and Sushi Cat 4" to the metadata edit above.
== Submitting Logos/Screenshots ==


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


If a game/animation needs content files added, submit a ZIP file containing the game/animation files, in the same format as the <code>content</code> folder of a standard curation. Submit the ZIP file by either uploading the file directly to Discord or uploading the file to our [http://bluepload.unstable.life/ public upload service] and sharing the link to the file.
Logos
└─── ID.png
Screenshots
└─── ID.png
└─── ID.png
└─── ID.png


If content files already in Flashpoint need to be moved or deleted, include those instructions in your Discord message.
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]


== Submitting Alternates ==
== Duplicates ==


In addition to metadata changes for existing entries, it is possible to submit alternate versions of games/animations that are already in Flashpoint. Alternates are listed on the right sidebar of Flashpoint Launcher when an entry 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/animation in your submission to make the process easier.
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]].


To submit an alternate, first follow the instructions in the "Submitting Assets" section. If you would like to submit Extras, just include an Extras folder in your ZIP file. If any other files are required (such as a Shockwave Xtra), include those as well. In your message, include the name of the entry to be modified, the name of the alternative app as will be shown in the launcher, and the launch command for said alternative app. Include any additional instructions for BlueMaxima if applicable. It should look something like this, but as long as you have all the essentials in the message in a not-stupid way, it should be okay:
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.


<code>Alternative App for Alien Hominid (Flash), Big Head Mod, http://uploads.ungrounded.net/10/alien_bighead.swf
<noinclude>
 
[[Category:Curation Guides]]
(link to folder here)</code>
</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"