Difference between revisions of "Metadata Edits"

From Flashpoint Database
Jump to: navigation, search
m (Submitting Assets)
(Duplicates)
 
(32 intermediate revisions by 7 users 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 to the appropriate channel under the "Pending Fixes" category 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 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 should wait until the next version to submit a metadata edit.
  
First, use your copy of Flashpoint to find the ID of the game/animation that you wish to change.
+
== Metadata Edits (JSONs) ==
 +
 
 +
First, use your copy of Flashpoint Infinity or Ultimate to find 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).
 +
# Change the metadata that you wish to change.
 +
# Once you're done, click the checkmark in the top right to save your changes.
 +
# 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.
 +
# Click Export.
 +
# 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.)
 +
# 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.
  
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.
+
Drag and drop this meta edit to [https://discord.com/channels/432708847304704010/912557298776416306 #metadata-jsons] 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.
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.
+
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).
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.
+
'''Note:''' You cannot do a pending fix on a curation that hasn't been in a public Flashpoint release yet. The ID generated by Core and by the master build of Flashpoint are not the same.
  
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]
 +
 
 +
== 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 [[#Submitting Assets (Content Changes)|Submitting Assets]].
 +
 
 +
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 specify which should be an alternate app of the other. The older entry takes precendence in not being deleted.
 +
 
 +
== Submitting Tech Changes (new plugins) ==
 +
 
 +
You will need to submit your changes directly with a merge request on our main project repository. Sign up for an account over at:
 +
 
 +
https://gitlab.fp.unstable.life/flashpoint/software/Flashpoint
  
 
== Submitting Alternates ==
 
== 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 Zipped Games" section, zipping the alternate as you would a full game. In your message to #new-zips, include the name of the entry the alternate belongs to, 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 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 (ID: 08143aa7-f3ae-45b0-a1d4-afa4ac44c845)
 +
Heading: Big Head Mod
 +
Application Path: FPSoftware\Flash\flashplayer_32_sa.exe
 +
Launch Command: http://uploads.ungrounded.net/10/alien_bighead.swf
 +
 
 +
<code>(link to folder here, or Discord upload)</code>
 +
 
 +
Submissions go in #new-zips.
 +
 
 +
If you would like to submit Extras, just include an Extras folder as an extra zipped file.  
 +
If any other files are required (such as a Shockwave Xtra), include those alongside the alt.
 +
 
 +
== Submitting Zipped Games ==
 +
 
 +
Follow the instructions on the [[Zipping Guide]] page and send it to #new-zips in the Pending Fixes section, stating it is a newly zipped game and noting which files to remove from Legacy\htdocs.
 +
 
 +
== Submitting Assets (Content Changes) ==
 +
 
 +
If a game/animation needs content files added, replaced, removed or otherwise fixed, you will need to assemble a complete game zip as per the Submitting Zipped Games section. Take the game's original files, add the fixed files on top of those files, then follow the [[Zipping Guide]] to make and test a GameZip. Finally, submit the zip via #new-zips, along with a list of files that can be safely removed from Legacy\htdocs, or if you're replacing an existing zipped game (whichever is applicable), and note why you have done so (what bug is fixed, what resources are replaced, etc.).
 +
 
 +
=== Examples of Noting Changes ===
 +
 
 +
(Game Name): Fixed missing sound effect (added example.com/example.wav)
  
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:
+
(Game Name): Updated game (replaced game.swf)
  
<code>Alternative App for Alien Hominid (Flash), Big Head Mod, http://uploads.ungrounded.net/10/alien_bighead.swf
+
(Game Name): Removed unneeded resources (removed bad_file.txt)
  
(link to folder here)</code>
+
<noinclude>
 +
[[Category:Curation Guides]]
 +
</noinclude>

Latest revision as of 23:11, 3 June 2022

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 to the appropriate channel under the "Pending Fixes" category 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 should wait until the next version to submit a metadata edit.

Metadata Edits (JSONs)

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 checkmark 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 #metadata-jsons 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).

Note: You cannot do a pending fix on a curation that hasn't been in a public Flashpoint release yet. The ID generated by Core and by the master build of Flashpoint are not the same.

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 Submitting Assets.

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 specify which should be an alternate app of the other. The older entry takes precendence in not being deleted.

Submitting Tech Changes (new plugins)

You will need to submit your changes directly with a merge request on our main project repository. Sign up for an account over at:

https://gitlab.fp.unstable.life/flashpoint/software/Flashpoint

Submitting Alternates

To submit an alternate, first follow the instructions in the "Submitting Zipped Games" section, zipping the alternate as you would a full game. In your message to #new-zips, include the name of the entry the alternate belongs to, 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 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 (ID: 08143aa7-f3ae-45b0-a1d4-afa4ac44c845)
Heading: Big Head Mod
Application Path: FPSoftware\Flash\flashplayer_32_sa.exe
Launch Command: http://uploads.ungrounded.net/10/alien_bighead.swf

(link to folder here, or Discord upload)

Submissions go in #new-zips.

If you would like to submit Extras, just include an Extras folder as an extra zipped file. If any other files are required (such as a Shockwave Xtra), include those alongside the alt.

Submitting Zipped Games

Follow the instructions on the Zipping Guide page and send it to #new-zips in the Pending Fixes section, stating it is a newly zipped game and noting which files to remove from Legacy\htdocs.

Submitting Assets (Content Changes)

If a game/animation needs content files added, replaced, removed or otherwise fixed, you will need to assemble a complete game zip as per the Submitting Zipped Games section. Take the game's original files, add the fixed files on top of those files, then follow the Zipping Guide to make and test a GameZip. Finally, submit the zip via #new-zips, along with a list of files that can be safely removed from Legacy\htdocs, or if you're replacing an existing zipped game (whichever is applicable), and note why you have done so (what bug is fixed, what resources are replaced, etc.).

Examples of Noting Changes

(Game Name): Fixed missing sound effect (added example.com/example.wav)
(Game Name): Updated game (replaced game.swf)
(Game Name): Removed unneeded resources (removed bad_file.txt)