Curation Format: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
m (Nosamu moved page CurationFormat to Curation Format: add space so title matches other wiki pages)
No edit summary
Line 3: Line 3:
There are games not allowed in Flashpoint for any reason, and should therefore be avoided for those reasons:
There are games not allowed in Flashpoint for any reason, and should therefore be avoided for those reasons:


* Games that are still on sale. You may make an effort to get them working in Flashpoint if you want, but we will not distribute currently paid content.
* Games that are still on sale. You may make an effort to get them working in Flashpoint if you want, but we will not distribute currently paid content. (Don't forget that some games start in web browsers then get paid versions later; be sure to check the history before you archive.)
* Any outright emulation of a game. Ports of games are absolutely fine, but games that are a ROM wrapped in an emulator are not allowed. Emulators themselves are allowed if they contain no games / allow you to load your own file.
* Any game from XForm Games.
* Any game from XForm Games.



Revision as of 22:37, 4 March 2019

Barred Games

There are games not allowed in Flashpoint for any reason, and should therefore be avoided for those reasons:

  • Games that are still on sale. You may make an effort to get them working in Flashpoint if you want, but we will not distribute currently paid content. (Don't forget that some games start in web browsers then get paid versions later; be sure to check the history before you archive.)
  • Any outright emulation of a game. Ports of games are absolutely fine, but games that are a ROM wrapped in an emulator are not allowed. Emulators themselves are allowed if they contain no games / allow you to load your own file.
  • Any game from XForm Games.

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 in #downloads on the Discord.

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

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

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

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.
  • Play Mode: One of the following, but up to three per game is possible:
    • Single Player: A solo experience from start to finish.
    • Cooperative: Like "Single Player", but with others being in the journey of finishing the game from start to finish.
    • Multiplayer: Playing against someone else or multiple players in session on who wins
  • 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 submitted through the proper channels on the Discord server:

  • #flash-game-submissions Flash games only.
  • #other-game-submissions Non-flash games only.
  • #animation-submissions Animations only.

You may choose to upload your .ZIP using Discord's built in uploading service or provide a link from an external filehost. If you have multiple curations you would like to submit you are also welcome to upload them as a single file for convenience.

You can download a full example ZIP file here.