Curation Format

From Flashpoint Database
Revision as of 00:05, 21 September 2019 by Wumbo (talk | contribs)
Jump to: navigation, search

This guide will walk you through everything you'll need to know before submitting your first curation to Flashpoint.

What is a Curation?

Generally, a curator is somebody tasked with maintaining the collection of an institution such as a museum or archive. In this case, a curator is responsible for submitting new games/animations to the Flashpoint collection. These games/animations are called curations.

Curating for Flashpoint is more than downloading an SWF, dropping it off in the Discord and expecting it to appear in the next update. You'll need a specific folder setup, screenshots, and a text file before that happens, all of which will be explained as you read further.

Before You Start

Checking the Master List

Often times, somebody will request a game or animation that's already been added to the project, better yet waste time curating it themselves. To make sure this doesn't happen to you, please check the Game Master List (and for animations, the Animation Master List) before possibly taking time out of your day to save something that's already been saved. Use CTRL+F to search the list of titles.

Barred Games

These are games/animations not allowed in Flashpoint for any reason. You can make an effort to get them working in Flashpoint if you want, but you may not request or submit them.

  • Games/animations that are still on sale, we will not distribute currently paid content. (Don't forget that some games start in web browsers for free then get paid versions later, the web browser version would be allowed in Flashpoint in this case; be sure to check the history before you archive.)
  • Games that require a server and have zero single player content. The amount of work it takes to preserve these is too high relative to what else we can be working on.
  • Any outright emulation of a commercial game (Such as a swf of Contra which contains the Contra ROM image). Ports of games are absolutely fine, but games that are a ROM wrapped in an emulator are not allowed unless they contain only non-commercial games and/or allow you to load your own.
  • Videos embedded in SWF files. If it plays perfectly fine in VLC Media Player, it doesn't belong in Flashpoint; please upload it to the Internet Archive instead.
    • This means that your curation can't be only a video embedded in a SWF. Games, animations and websites that use video are allowed, and you should include the video files and/or SWFs containing video in the curation.
  • Any game from XForm Games (At their request)
  • Windows 93 (At their request)
  • Dragon Ball Devolution and other games from www.txori.com (At their request)
  • Any game developed by Nitrome (At their request)
  • Flash Flash Revolution (At their request)
  • Any game developed by Farrago Fiction (At their request)
  • Any game/animation developed by Anonymous-Frog (At their request)

It should go without saying that blatantly illegal games/animations are not allowed, either.

Content

All content must 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 a game was hosted at 'http://uploads.ungrounded.net/59000/59593_alien_booya202c.swf' you would do the folders in this example like the image below. If that is not working for some reason, a secondary format is acceptable - a domain folder, a folder with the game's name, then the game files, displayed as the second example.

Starting with Flashpoint 5.1, the domain folder should NEVER be localflash unless the source files don't come from a concrete internet location (a ZIP file or CD, for example).

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, outside the content folder, and contain all of the fields in the following examples.

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. Don't put "Danny Phantom" if the game is based on the Danny Phantom show, only if there is a very specific series pertaining to that game.
  • 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: See Genres.
  • 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 location of your file inside the content folder, replicating an internet URL. This is case-sensitive. Never have https:// at the beginning of a URL, it will eventually break something. ALWAYS use http://. If a URL has https:// at the beginning, it's wrong, end of story.
  • Notes: A message that will appear in the right panel of the launcher. Reserve this for important tidbits related to how the game works that should be known before playing.
  • 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:
Play Mode: Single Player 
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:
Play Mode: 
Status: Playable
Extreme: No
Genre: 
Source: 
Launch Command: 
Notes: 
Author Notes: 

Testing

You'll need Flashpoint Core to test your games in a lightweight copy of Flashpoint you can afford to break.

Place the files from inside your content folder within the Server\htdocs\ directory. Once you've done this, open the Core launcher, click the "New Game" button in the bottom right and mirror the info from your Meta.txt into the right panel. Click the checkmark and open your curation - if everything goes well, your game should open in a new window! If it doesn't, make sure you're copying the contents of your content folder and not the folder itself.

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

Packing it up

You've finished your first curation! All of these files should now be packed into a single .ZIP file and submitted to our #curator-lounge on the Discord. If your curation is up to snuff, you'll be given Trial Curator status, which will let you submit curations through the curation channels. You can use Discord's own upload feature for files under 8MB, an external filehost for bigger files (such as MEGA, or our own file host, which is linked in the pinned messages of our submission channels.

You can download a full example ZIP file here.

Aftermath

Editing Your Curations

If you notice a mistake with your curation after you've submitted it, read our article on Metadata Edits and head over to the #metadata-edits channel in our Discord so you can make necessary changes.

Having Problems?

Because we can't remind you enough already: Join our Discord and ask away in the #help-me-please channel.