Curation Format

From Flashpoint Datahub
Revision as of 23:31, 3 December 2018 by BlueMaxima (talk | contribs)
Jump to navigation Jump to search

Testing

You'll want Flashpoint Core to help test games in a copy of Flashpoint that you can afford to break. You can find it here. You'll find a video tutorial in Flashpoint Core that will help with getting acquainted to the platform.

All games should be tested in Flashpoint, if not Core then at least the full version. Just opening the game in the flash projector is not enough of a test.

SWFs

All SWFs need to be placed inside a 'content' folder, then arranged in the same way that they would be placed in Flashpoint proper from the htdocs folder - the best practice is to try and recreate the same structure that the game had on the internet. For example, if an SWF was hosted at 'http://uploads.ungrounded.net/59000/59593_alien_booya202c.swf' you would do the folders in the first example in the example image below. If that is not available or not working for some reason, a secondary format is acceptable - a domain folder, a folder with the game's name, then the game SWF/files, displayed as the second example.

The domain folder should never be localflash after 5.1.

Examples

  • This is assuming you've already tested the game with Flashpoint Core. Don't forget the folder with the game's name!

    This is assuming you've already tested the game with Flashpoint Core. Don't forget the folder with the game's name!

Logos must be in PNG format, and have the entire title of a game, or something that is representative of the game. To be named 'logo.png' in all cases.

Recommended tools include Snipping Tool and Paint, both included in Windows 10 by default. You're free to use other tools, just remember, always use PNG.

Examples

  • Bad example. Crop it down to just the logo.

    Bad example. Crop it down to just the logo.

  • Good example. Logo is sufficiently cropped.

    Good example. Logo is sufficiently cropped.

  • Good example. Can show off a bit of the artists work, but no menu options or other things to get in the way.

    Good example. Can show off a bit of the artists work, but no menu options or other things to get in the way.

  • Good example. If no title is available, a decent shot of the focal point of the game will do instead.

    Good example. If no title is available, a decent shot of the focal point of the game will do instead.

Screenshot

Screenshots must be in PNG format, and have a credible 'action shot' of the game (no menus or obvious tutorials). To be named 'ss.png' in all cases.

Recommended tools include Snipping Tool and Paint, both included in Windows 10 by default. You're free to use other tools, just remember, always use PNG.

Examples

  • Bad example. Don't show obvious tutorials.

    Bad example. Don't show obvious tutorials.

  • Bad example. Don't show menus, unless the entire point of the game is menus. Work your way to a battle in an RPG or strategy game.

    Bad example. Don't show menus, unless the entire point of the game is menus. Work your way to a battle in an RPG or strategy game.

  • Good example. Shows some action. Dying is sometimes unavoidable - don't feel bad if the screenshot is otherwise good.

    Good example. Shows some action. Dying is sometimes unavoidable - don't feel bad if the screenshot is otherwise good.

  • Great example. Shows a lot of action and what the game's big draw is.

    Great example. Shows a lot of action and what the game's big draw is.

Metadata

The metadata must be included in a file named 'meta.txt', and contain all of the fields in the following examples.

Example

List of Metadata Required

You need to add the field, but you can leave it blank if the field is not applicable (unknown developer, no series, no notes, etc.)

  • Title: The name of the game, in full. If the game's been hacked, add (Hacked) onto the end of the title.
  • Series: The series the game is in. FLASH SERIES ONLY - don't put "Danny Phantom" if the game is a Danny Phantom game, only if there is a very specific series for that game in Flash.
  • Developer: The name of the developer, or developers. Separate multiple developers with the , symbol.
  • Publisher: The site that published (released/branded) the game.
  • Status: One of the following:
    • Not Working: The game doesn't work.
    • Playable: Fully playable from beginning to end.
    • Playable (Partial): The game is playable but incomplete/unfinishable.
  • Extreme: Whether or not the game should be hidden when asked because of thoroughly extreme content not appropriate for younger people.
  • Genre:
  • Source: The website you retrieved the game from. Both a full URL and simply the name of the website (with the .com/etc at the end) are acceptable.
  • Launch Command: The line "Application Command-Line Parameters" inside Flashpoint. This is case-sensitive.
  • Notes: Anything that will appear between the metadata and before the screenshots in LaunchBox's Details interface.
  • Author Notes: This line will only be seen in the autocuration tool. Great for if you want to warn someone off adding the game in the traditional way.

A Good meta.txt

Title: Alien Hominid
Series: 
Developer: The Behemoth
Publisher: 
Status: Playable
Extreme: No
Genre: Shooter
Source: Newgrounds.com
Launch Command: http://uploads.ungrounded.net/59000/59593_alien_booya202c.swf
Notes: 
Author Notes: Thanks for your work!

Blank meta.txt

Title: 
Series:
Developer: 
Publisher: 
Status: Playable
Extreme: No
Genre: 
Source: 
Launch Command: 
Notes: 
Author Notes:

Packing it up

All of these files should now be packed into a single .ZIP file and sent to me. You should place the contents inside the zip, inside of a folder with the game name.

You can download a full example ZIP file here.

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