New Curation Format - Revision history

Nosamu: This page has been rolled out to the main Curation Format page!

2019-11-01T09:17:03Z

This page has been rolled out to the main Curation Format page!

Nosamu: Added YAML section

2019-10-25T23:20:39Z

Added YAML section

← Older revision		Revision as of 01:20, 26 October 2019
Line 206:		Line 206:
	Curation Notes:		Curation Notes:
	Additional Applications: </nowiki>		Additional Applications: </nowiki>

			===Using YAML===

			In addition to our custom <code>meta.txt</code> format, Flashpoint curations also support metadata written in YAML format. To use YAML, create a <code>meta.yml</code> or <code>meta.yaml</code> file instead of a <code>meta.txt</code> file. Then, follow the instructions in our [[YAML Format]] article.

	==Testing==		==Testing==

Nosamu at 10:23, 24 October 2019

2019-10-24T10:23:07Z

← Older revision		Revision as of 12:23, 24 October 2019
Line 155:		Line 155:
	\|-		\|-
	\| '''Curation Notes'''		\| '''Curation Notes'''
	\| Use this field to show a message to BlueMaxima if he needs to add your curation in a different way from usual. For multi-line Curation Notes, use the pipe symbol: <code>Curation Notes: <nowiki> \| </nowiki></code>, then indent each line ~~of the Notes~~.		\| Use this field to show a message to BlueMaxima if he needs to add your curation in a different way from usual. For multi-line Curation Notes, use the pipe symbol: <code>Curation Notes: <nowiki> \| </nowiki></code>, then indent each line.
	\|-		\|-
	\| '''Additional Applications'''		\| '''Additional Applications'''

Nosamu: Added explanation of the Original Description field (which I forgot until now, oops!)

2019-10-24T10:21:32Z

Added explanation of the Original Description field (which I forgot until now, oops!)

← Older revision		Revision as of 12:21, 24 October 2019
Line 78:		Line 78:

	Some fields have a few possible values to choose from. If this is the case, they'll be shown in the table as a bulleted list, with the default value in ''italics''. If you omit this type of field, it will take on its default value automatically.		Some fields have a few possible values to choose from. If this is the case, they'll be shown in the table as a bulleted list, with the default value in ''italics''. If you omit this type of field, it will take on its default value automatically.

			If you're not sure how to use a metadata field, be sure to check the [[#A Good meta.txt\|example meta.txt]].

	===List of Metadata Fields===		===List of Metadata Fields===
Line 147:		Line 149:
	\|-		\|-
	\| '''Notes'''		\| '''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. For multi-line Notes, use the pipe symbol: <code>Notes: <nowiki> \| </nowiki></code>, then indent each line of the Notes. ~~See~~ the ~~Examples section for more details~~.		\| 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. For multi-line Notes, use the pipe symbol: <code>Notes: <nowiki> \| </nowiki></code>, then indent each line of the Notes.
			\|-
			\| '''Original Description'''
			\| If a game's webpage contains a description of the game, you may copy and paste it into this field. For multi-line descriptions, use the pipe symbol: <code>Original Description: <nowiki> \| </nowiki></code>, then indent each line.
	\|-		\|-
	\| '''Curation Notes'''		\| '''Curation Notes'''
	\| Use this field to show a message to BlueMaxima if he needs to add your curation in a different way from usual. For multi-line Curation Notes, use the pipe symbol: <code>Curation Notes: <nowiki> \| </nowiki></code>, then indent each line of the Notes~~. See the Examples section for more details~~.		\| Use this field to show a message to BlueMaxima if he needs to add your curation in a different way from usual. For multi-line Curation Notes, use the pipe symbol: <code>Curation Notes: <nowiki> \| </nowiki></code>, then indent each line of the Notes.
	\|-		\|-
	\| '''Additional Applications'''		\| '''Additional Applications'''
Line 156:		Line 161:
	\|-		\|-
	\|}		\|}

	===A Good meta.txt===		===A Good meta.txt===

Nosamu at 09:53, 24 October 2019

2019-10-24T09:53:02Z

← Older revision		Revision as of 11:53, 24 October 2019
Line 158:		Line 158:
	===A Good meta.txt===		===A Good meta.txt===

	<nowiki>		<nowiki>
	Title: Alien Hominid		Title: Alien Hominid
	Series:		Series:
Line 179:		Line 179:
	===Blank meta.txt===		===Blank meta.txt===

	<nowiki>		<nowiki>
	Title:		Title:
	Library:		Library:

Nosamu at 09:51, 24 October 2019

2019-10-24T09:51:12Z

← Older revision		Revision as of 11:51, 24 October 2019
Line 13:		Line 13:
	==What is a Curation?==		==What is a Curation?==

	Flashpoint is not just a collection of files; it is a museum of playable web games. As in any other museum, each item needs to be curated before it can be put on display. 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, all packaged in~~ an archive file (ZIP, 7Z, etc) called a ''curation''.		Flashpoint is not just a collection of files; it is a museum of playable web games. As in any other museum, each item needs to be curated before it can be put on display. Curating for Flashpoint is more than downloading an SWF, dropping it off in the Discord and expecting it to appear in the next update. Instead, you'll need to put together an archive file (ZIP, 7Z, etc) called a ''curation''.

	To make a curation, first create a new folder with the name of the game you'd like to save. (Windows won't let you create a folder name with certain special characters; you'll need to remove them from the folder name if that happens.) Inside your curation folder, you'll add a ''screenshot'' and ''logo'', a ''text file'' containing metadata about the game, and a ''content'' folder containing all of the files required to run the game. The following sections will explain each of these required items in detail. Be sure to download our complete [https://bluepload.unstable.life/alienhominid.zip example curation ZIP file] and follow along.		To make a curation, first create a new folder with the name of the game you'd like to save. (Windows won't let you create a folder name with certain special characters; you'll need to remove them from the folder name if that happens.) Inside your curation folder, you'll add a ''screenshot'' and ''logo'', a ''text file'' containing metadata about the game, and a ''content'' folder containing all of the files required to run the game. The following sections will explain each of these required items in detail. Be sure to download our complete [https://bluepload.unstable.life/alienhominid.zip example curation ZIP file] and follow along.

Nosamu: Consolidated similar sections in the intro

2019-10-24T09:41:20Z

Consolidated similar sections in the intro

← Older revision		Revision as of 11:41, 24 October 2019
Line 1:		Line 1:
	This guide will walk you through everything you need to know about putting together a curation and submitting it to Flashpoint. If this is your first time contributing, be sure to follow our [[Curation Tutorial\|step-by-step tutorial]].		This guide will walk you through everything you need to know about putting together a curation and submitting it to Flashpoint. If this is your first time contributing, be sure to follow our [[Curation Tutorial\|step-by-step tutorial]].

	~~==What is a Curation?==~~

	Flashpoint is not just a collection of files; it is a museum of playable web games. As in any other museum, each item needs to be curated before it can be put on display. 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, all packaged in an archive called a ''curation''. All of this will be explained as you read further.

	==Before You Start==		==Before You Start==

	===Checking the Master List===		===Checking the Master List===

	Before curating, 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.'''		Before curating, 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.'''

Line 14:		Line 11:
	{{:Not Accepted Games}}		{{:Not Accepted Games}}

	==~~Overview~~==		==What is a Curation?==

			Flashpoint is not just a collection of files; it is a museum of playable web games. As in any other museum, each item needs to be curated before it can be put on display. 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, all packaged in an archive file (ZIP, 7Z, etc) called a ''curation''.

	~~A ''curation'' is a compressed folder (any common archive format like ZIP or 7Z is fine).~~ To make a curation, first create a new folder with the name of the game you'd like to save. (Windows won't let you create a folder name with certain special characters; you'll need to remove them from the folder name if that happens.) Inside your curation folder, you'll add a ''screenshot'' and ''logo'', a ''text file'' containing metadata about the game, and a ''content'' folder containing all of the files required to run the game. The following sections will explain each of these required items in detail. Be sure to download our complete [https://bluepload.unstable.life/alienhominid.zip example curation ZIP file] and follow along.		To make a curation, first create a new folder with the name of the game you'd like to save. (Windows won't let you create a folder name with certain special characters; you'll need to remove them from the folder name if that happens.) Inside your curation folder, you'll add a ''screenshot'' and ''logo'', a ''text file'' containing metadata about the game, and a ''content'' folder containing all of the files required to run the game. The following sections will explain each of these required items in detail. Be sure to download our complete [https://bluepload.unstable.life/alienhominid.zip example curation ZIP file] and follow along.

	<gallery mode="traditional">		<gallery mode="traditional">

Nosamu at 09:30, 24 October 2019

2019-10-24T09:30:52Z

← Older revision		Revision as of 11:30, 24 October 2019
Line 40:		Line 40:
	==Logo==		==Logo==

	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.		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 <code>logo.png</code> 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.		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.
Line 57:		Line 57:
	==Screenshot==		==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.		Screenshots must be in PNG format, and have a credible 'action shot' of the game (no menus or obvious tutorials). To be named <code>ss.png</code> 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.		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.

Nosamu: formatting fix

2019-10-24T09:29:02Z

formatting fix

← Older revision		Revision as of 11:29, 24 October 2019
Line 26:		Line 26:
	==Content==		==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.		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 <code>http://uploads.ungrounded.net/59000/59593_alien_booya202c.swf</code> 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.

	You might notice that some games in Flashpoint use a domain called <code>localflash</code> instead of a website domain. This is a legacy practice, and it is '''not used anymore''' unless the source files come from a CD, ZIP file, or other offline location.		You might notice that some games in Flashpoint use a domain called <code>localflash</code> instead of a website domain. This is a legacy practice, and it is '''not used anymore''' unless the source files come from a CD, ZIP file, or other offline location.

Nosamu: Updated example curation, example metas, and misc cleanup

2019-10-24T09:26:31Z

Updated example curation, example metas, and misc cleanup

← Older revision		Revision as of 11:26, 24 October 2019
Line 8:		Line 8:

	===Checking the Master List===		===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.'''		Before curating, 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===		===Barred Games===
Line 16:		Line 16:
	==Overview==		==Overview==

	A ''curation'' is a compressed folder (any common archive format like ZIP or 7Z is fine). To make a curation, ~~you'll be making a folder, adding all of the required files to it, and finally zipping it up. First,~~ create a new folder with the name of the game you'd like to save. (Windows won't let you create a folder name with certain special characters; you'll need to remove them from the folder name if that happens.) Inside your curation folder, you'll ~~adding~~ a ''screenshot'' and ''logo'', a ''text file'' containing metadata about the game, and a ''content'' folder containing all of the files required to run the game. The ~~next~~ sections will explain each of these required items in detail. Be sure to download our complete [~~http~~://~~bluemaxima~~.~~org/flashpoint/datahub~~/~~AlienHominid~~.zip example curation ZIP file] and follow along.		A ''curation'' is a compressed folder (any common archive format like ZIP or 7Z is fine). To make a curation, first create a new folder with the name of the game you'd like to save. (Windows won't let you create a folder name with certain special characters; you'll need to remove them from the folder name if that happens.) Inside your curation folder, you'll add a ''screenshot'' and ''logo'', a ''text file'' containing metadata about the game, and a ''content'' folder containing all of the files required to run the game. The following sections will explain each of these required items in detail. Be sure to download our complete [https://bluepload.unstable.life/alienhominid.zip example curation ZIP file] and follow along.

	<gallery mode="traditional">		<gallery mode="traditional">
Line 159:		Line 159:
	===A Good meta.txt===		===A Good meta.txt===

	Title: Alien Hominid		<nowiki>
	Series:		Title: Alien Hominid
	Developer: The Behemoth		Series:
	Publisher:		Developer: The Behemoth
	Play Mode: Single Player		Publisher: Newgrounds.com
	~~Status~~: ~~Playable~~		Play Mode: Single Player
	Extreme: No		Release Date: 2002-08-07
	~~Genre~~: Shooter		Version: 1.0
	Source: ~~Newgrounds~~.com		Extreme: No
	Launch Command: http://uploads.ungrounded.net/59000/59593_alien_booya202c.swf		Tags: Shooter
	Notes:		Source: https://www.newgrounds.com/portal/view/59593
	~~Author~~ Notes: Thanks for your work!		Platform: Flash
			Application Path: FPSoftware\Flash\flashplayer_32_sa.exe
			Launch Command: http://uploads.ungrounded.net/59000/59593_alien_booya202c.swf
			Notes: \|
			This is our sample curation in Flashpoint Core.
			Multiple lines in notes and descriptions are cool.
			Curation Notes: Thanks for your work!</nowiki>

	===Blank meta.txt===		===Blank meta.txt===

	Title:		<nowiki>
	Series:		Title:
	Developer:		Library:
	Publisher:		Series:
	Play Mode:		Developer:
	~~Status~~: ~~Playable~~		Publisher:
	Extreme: No		Play Mode:
	~~Genre~~:		Release Date:
	Source:		Version:
	Launch Command:		Languages:
	Notes:		Extreme:
	~~Author~~ Notes:		Tags:
			Source:
	~~Remember to place all 3 just outside the content folder.~~		Platform:
			Status:
			Application Path:
			Launch Command:
			Notes:
			Original Description:
			Curation Notes:
			Additional Applications: </nowiki>

	==Testing==		==Testing==

	You'll need [https://bluemaxima.org/flashpoint/~~Flashpoint%20Core%203.1.zip~~ Flashpoint Core] to test your games in a lightweight copy of Flashpoint you can afford to break.		You'll need [https://bluemaxima.org/flashpoint/downloads/ 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.		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.
Line 201:		Line 214:
	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, or [https://unstable.life/submissions.html our own file host] for bigger files. This is also linked in the channel topics of our submission channels on Discord.		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, or [https://unstable.life/submissions.html our own file host] for bigger files. This is also linked in the channel topics of our submission channels on Discord.

	[~~http~~://~~bluemaxima~~.~~org/flashpoint/datahub~~/~~AlienHominid~~.zip Here is the full example ZIP file.]		[https://bluepload.unstable.life/alienhominid.zip Here is the full example ZIP file.]
	(This was also linked earlier, in the Overview section).		(This was also linked earlier, in the Overview section).