Difference between revisions of "Metadata Edits"

From Flashpoint Database
Jump to: navigation, search
(Added link to the Curation Format page)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[File:Curationedits.png|thumb|Shows how to find the ID of a game in Flashpoint Launcher.]]
+
[[File:Curationedits.png|thumb|Shows where to find the ID of a game in Flashpoint Launcher.]]
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. All metadata changes should be submitted in our #pending-fixes channel on Discord, including game/animation assets if necessary.  
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 shortly after you've submitted it, you should delete and resubmit the curation within a few minutes of posting. If you notice later than that, you should wait until the next version.
  
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 Edits ==
  
== Submitting Metadata Edits ==
+
First, use your copy of Flashpoint Infinity or Ultimate to find the game/animation that you wish to change.
 
 
First, use your copy of Flashpoint Infinity or Ultimate to find the ID of the game/animation that you wish to change.
 
 
# Click the entry to select it.
 
# 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.
 
# 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.
+
# Keep the ID of the game in mind (see screenshot 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:
+
# Change the metadata that you wish to change.
* Download [http://bluemaxima.org/flashpoint/downloads/ Flashpoint Infinity Nightly] and follow the steps above.
+
# Once you're done, click the tick in the top right to save your changes.
* Ask in the Flashpoint Discord for the ID of the game.
+
# Right click the game entry for a drop down menu, and click Export Meta Edit.
 
+
# Click the checkbox for each metadata type that you've changed.
Once you've found the ID of the game, create a text specifying the new value for each field you would like to update. See the [[Curation Format#List of Metadata Fields|Curation Format]] for a guide on how to use the metadata fields. The example below will change the Developer and Publisher of the entry for Elephant Quest.
+
# Click Export.
GAME 1e2f9810-f19f-4caa-bedb-1124ab04a630
+
# Go into your Flashpoint folder, then Data, then the MetaEdits folder. (If you haven't done a metadata edit previously, this folder will have been created.)
Developer: Armor Games; jmtb02; Jimp
+
# Remember that ID from a few steps back? You'll now have a file with that filename in this folder. This is your meta edit.
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:
 
# 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.
 
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.
+
Drag and drop this meta edit to #pending-fixes and Discord will allow you to upload it straight to the channel. Type a message stating what the pending edit does (eg: "Updates the developer and description for Bowman".) If you wish to perform multiple pending fixes at a time, a zip file with all of the files is also acceptable.
  
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.
+
You can test your meta edits if you so wish. By leaving the files in the MetaEdits folder, you can use the Developer tab (remember to enable it via Config), and use the Import Meta Edits button (the second set of buttons, furthest to the right). Simply click the button and you'll see a summary of your pending edits (they will be noted as "discarded changes" because they'll be the same in your copy).
  
 
== Submitting Assets ==
 
== Submitting Assets ==

Latest revision as of 04:12, 1 July 2020

Shows where to find the ID of a game in Flashpoint Launcher.

This page describes how to submit metadata changes to games or animations that are already in Flashpoint. 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 shortly after you've submitted it, you should delete and resubmit the curation within a few minutes of posting. If you notice later than that, you should wait until the next version.

Metadata Edits

First, use your copy of Flashpoint Infinity or Ultimate to find the game/animation that you wish to change.

  1. Click the entry to select it.
  2. 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.
  3. Keep the ID of the game in mind (see screenshot on the right).
  4. Change the metadata that you wish to change.
  5. Once you're done, click the tick in the top right to save your changes.
  6. Right click the game entry for a drop down menu, and click Export Meta Edit.
  7. Click the checkbox for each metadata type that you've changed.
  8. Click Export.
  9. Go into your Flashpoint folder, then Data, then the MetaEdits folder. (If you haven't done a metadata edit previously, this folder will have been created.)
  10. Remember that ID from a few steps back? You'll now have a file with that filename in this folder. This is your meta edit.

Drag and drop this meta edit to #pending-fixes and Discord will allow you to upload it straight to the channel. Type a message stating what the pending edit does (eg: "Updates the developer and description for Bowman".) If you wish to perform multiple pending fixes at a time, a zip file with all of the files is also acceptable.

You can test your meta edits if you so wish. By leaving the files in the MetaEdits folder, you can use the Developer tab (remember to enable it via Config), and use the Import Meta Edits button (the second set of buttons, furthest to the right). Simply click the button and you'll see a summary of your pending edits (they will be noted as "discarded changes" because they'll be the same in your copy).

Submitting Assets

If a game/animation needs content files added, submit a ZIP file containing the game/animation files, in the same format as the content folder of a standard curation. Submit the ZIP file by either uploading the file directly to Discord or uploading the file to our public upload service and sharing the link to the file.

If content files already in Flashpoint need to be moved or deleted, include those instructions in your Discord message.

Submitting Alternates

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.

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:

Alternative App for Alien Hominid (Flash), Big Head Mod, http://uploads.ungrounded.net/10/alien_bighead.swf

(link to folder here)