Curation Format: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
No edit summary
No edit summary
Line 16: Line 16:


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.
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.
'''Never have https:// at the beginning of a URL, it will eventually break something. Always, ALWAYS, use http://. If a URL has https:// at the beginning, it's wrong, end of story.'''


''The domain folder should '''never''' be localflash after 5.1.''
''The domain folder should '''never''' be localflash after 5.1.''

Revision as of 01:26, 15 May 2019

The Golden Rule

You only upload a game to Flashpoint once. I'll accept edits for mistakes later, but you won't be uploading the game twice. So, try and get it right the first time. If you need to make an edit or addition, describe them on #curator-lounge and ping BlueMaxima.

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.
    • While not emulation, fan remakes/conversions of Nintendo projects like Full Screen Mario are too risky to add if they were taken down by Nintendo. Not all remakes/conversions are risky though, if you are unsure just ask in #curators.
  • Videos embedded in SWF files:
    • If the SWF has nothing on it other than it requiring a separate FLV to run the SWF file properly (and if the FLV works perfectly fine on VLC), then it won't be allowed on Flashpoint and it should rather be uploaded through Archive.org
    • If it uses any Flash elements like ui, special effects, loop etc., it can be curated.
    • 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.
  • Animations using the HTML5 platform have to include animated components and make use of HTML5-specific tags, CSS, and/or Javascript.
  • Games/animations with cub, shotacon or lolicon content.
  • The following are not allowed at developer request:
    • Any game from XForm Games that is not already in the database
    • Windows 93
    • Dragon Ball Devolution, and other games from www.txori.com
    • Any game developed by Nitrome
    • Flash Flash Revolution
    • Any game developed by Farrago Fiction
    • Any game/animation developed by Anonymous-Frog
    • Non-classic versions of Cookie Clicker

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


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.

Never have https:// at the beginning of a URL, it will eventually break something. Always, ALWAYS, use http://. If a URL has https:// at the beginning, it's wrong, end of story.

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 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 drag and drop for files under 8MB, an external filehost for bigger files, or our file host, which is in the pinned messages in #flash-game-curations.

You can download a full example ZIP file here.