Difference between revisions of "Alambik Curation"

From Flashpoint Database
Jump to: navigation, search
m (we're just not bothering with these)
 
(22 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<center>{{Header Template|[[File:Incomplete.png]]|This page is incomplete, and thus is in my namespace. It will be added to in the future, and can be edited by anyone.}}</center>
 
 
This guide will show you how to curate Alambik content using Flashpoint Core.
 
This guide will show you how to curate Alambik content using Flashpoint Core.
  
 
== Before you start ==
 
== Before you start ==
* This tutorial will assume you've read the standard Curation Tutorial, which is highly recommended to go through. Try curating a Flash game before moving on to other platforms like Alambik.
+
* This tutorial will assume you've read the standard [[Curation Tutorial]], which is highly recommended to go through. Try curating a Flash game before moving on to other platforms like Alambik.
* [http://www.the-demo.com/ THE-DEMO.COM] has a large list of Alambik applications, however you must go to the Internet Archive to find the files.
+
* You must extract the [https://discord.com/channels/432708847304704010/596548932373577750/882749647351844874 Alambik Support Pack Update] into Core.
* ''This currently needs a support pack. The support pack is not available, as a bug has yet to be fixed.''
 
  
== Which Launch Command to use ==
+
== Which Application Path to use ==
Use <code>startAlambik.bat</code> with just the Alambik file first. If this doesn't work, use <code>startAlambikInBrowser.bat</code> with just the Alambik file. If this still doesn't work, embed the Alambik file in an HTML file.
+
Use <code>startAlambik.bat</code> with just the Alambik file first. See the [[#Troubleshooting|Troubleshooting]] section if it doesn't work or is too fast.
  
 
== How to recognize an Alambik application ==
 
== How to recognize an Alambik application ==
 
* It is described as an Alambik application somewhere on the site.
 
* It is described as an Alambik application somewhere on the site.
* It uses the <code>.tv</code>, <code>.tvs</code>, <code>.tvd</code>, <code>.tvv</code>, <code>.tvb</code>, or <code>.tvl</code> file extension.
+
* It mentions MCNL ('''M'''ulti '''C'''ontent '''N'''atural '''L'''anguage) or Alambik Script.
 +
* It uses the <code>.tv</code>, <code>.tvs</code>, <code>.tvv</code>, <code>.tvb</code>, <code>.tvl</code>, or <code>.tvd</code> file extension.<!--
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
! Extension
 +
! MIME type
 +
|-
 +
| <code>.tv</code>
 +
| <code>application/x-alambik-</code>
 +
|-
 +
| <code>.tvs</code>
 +
| <code>application/x-alambik-script</code>
 +
|-
 +
| <code>.tvv</code>
 +
| <code>application/x-alambik-securescript</code>
 +
|-
 +
| <code>.tvb</code>
 +
| <code>application/x-alambik-</code>
 +
|-
 +
| <code>.tvl</code>
 +
| <code>application/x-alambik-</code>
 +
|-
 +
| <code>.tvd</code>
 +
| <code>application/x-alambik-data</code>
 +
|}
 +
-->
  
 
== Meta Fields ==
 
== Meta Fields ==
Many meta fields can be found by right clicking, then pressing View Sources. This works in both standalone and the browser.
+
Many meta fields can be found by right clicking, then pressing <code>View Sources</code>. This works in both standalone and the browser, however only works on some files.
* Title - Use the <code>Script name</code> field, and all titles mentioned elsewhere should be added as Alternate Titles.
+
* Title - Use the <code>Script name</code> field '''unless there is a different title in the game itself''', and all titles mentioned elsewhere should be added as Alternate Titles.
 
* Developer - Use the <code>Author</code> field.
 
* Developer - Use the <code>Author</code> field.
* Release Date - Use the <code>Last update</code> field; this is the date (in MM.DD.YYYY format) of which the file was last changed, but it doesn’t always match with the actual release date.
+
* Release Date - Use the <code>Production date</code> field; this is the date (in MM.DD.YYYY format) of which the file was produced, but it doesn’t always match with the actual release date; use one from the site (or in-game) if there is one.
 
* Original Description - Use the <code>Short comment</code> field; append any other descriptions to this with two blank lines separating them.
 
* Original Description - Use the <code>Short comment</code> field; append any other descriptions to this with two blank lines separating them.
 
* Version - Do '''not''' use the <code>Alambik Script version</code> or <code>Mediamaker version</code> fields; use a version located elsewhere if you can find one.
 
* Version - Do '''not''' use the <code>Alambik Script version</code> or <code>Mediamaker version</code> fields; use a version located elsewhere if you can find one.
  
 
== Troubleshooting ==
 
== Troubleshooting ==
* The player requests some tracking files, from <code>www.alambik.com/checking</code>, <code>www.alambik.com/cgi-bin</code>, and <code>check.ipcheck.com/cgi-bin</code>. These can be safely ignored; do not place them in your curation, even though some of them 404.
+
* ''It doesn't work in the player or is a microsite/needs an embed!'' Add <code>browser</code> to the beginning of your Launch Command, changing it to something like <code>browser http://example.com/game.html</code>.
* If you have any questions/problems, ask in [https://discord.com/channels/432708847304704010/714335844940513342 #plugin-chat].
+
* ''It's too fast!'' Add <code>cpu speed</code> to the end of the Launch Command, replacing <code>speed</code> with a number that can be found using trial and error (200 is a good starting point), changing it to something like <code>http://example.com/game.tvs cpu 300</code>. This works with the above browser change.
 +
* The player requests some tracking files, from <code>www.alambik.com/checking</code>, <code>www.alambik.com/cgi-bin</code>, and <code>check.ipcheck.com/cgi-bin</code>, alongside some "redirect" subpages. These can be safely ignored; do not place them in your curation, even though some of them 404.
 +
* If you have any questions/problems, ask in the #plugin-chat channel in our Discord server.
  
 
== Wrapping It Up ==
 
== Wrapping It Up ==
As mentioned earlier, the player requests some tracking files, from <code>www.alambik.com/checking</code>, <code>www.alambik.com/cgi-bin</code>, and <code>check.ipcheck.com/cgi-bin</code>. These can be safely ignored; do not place them in your curation, even though some of them 404.
+
{{:Wrapping It Up}}
 
 
When you're finished testing, export the curation and name the .7z file with the name of the app, and submit it to the #other-game-curations or #animation-curations channel of the Flashpoint Discord. Use the Alambik emoji ([[File:Alambik logo.png|20px]]) when submitting.
 
 
 
 
<noinclude>
 
<noinclude>
 
[[Category:Curation Guides]]
 
[[Category:Curation Guides]]
 
</noinclude>
 
</noinclude>

Latest revision as of 10:35, 2 September 2021

This guide will show you how to curate Alambik content using Flashpoint Core.

Before you start

  • This tutorial will assume you've read the standard Curation Tutorial, which is highly recommended to go through. Try curating a Flash game before moving on to other platforms like Alambik.
  • You must extract the Alambik Support Pack Update into Core.

Which Application Path to use

Use startAlambik.bat with just the Alambik file first. See the Troubleshooting section if it doesn't work or is too fast.

How to recognize an Alambik application

  • It is described as an Alambik application somewhere on the site.
  • It mentions MCNL (Multi Content Natural Language) or Alambik Script.
  • It uses the .tv, .tvs, .tvv, .tvb, .tvl, or .tvd file extension.

Meta Fields

Many meta fields can be found by right clicking, then pressing View Sources. This works in both standalone and the browser, however only works on some files.

  • Title - Use the Script name field unless there is a different title in the game itself, and all titles mentioned elsewhere should be added as Alternate Titles.
  • Developer - Use the Author field.
  • Release Date - Use the Production date field; this is the date (in MM.DD.YYYY format) of which the file was produced, but it doesn’t always match with the actual release date; use one from the site (or in-game) if there is one.
  • Original Description - Use the Short comment field; append any other descriptions to this with two blank lines separating them.
  • Version - Do not use the Alambik Script version or Mediamaker version fields; use a version located elsewhere if you can find one.

Troubleshooting

  • It doesn't work in the player or is a microsite/needs an embed! Add browser to the beginning of your Launch Command, changing it to something like browser http://example.com/game.html.
  • It's too fast! Add cpu speed to the end of the Launch Command, replacing speed with a number that can be found using trial and error (200 is a good starting point), changing it to something like http://example.com/game.tvs cpu 300. This works with the above browser change.
  • The player requests some tracking files, from www.alambik.com/checking, www.alambik.com/cgi-bin, and check.ipcheck.com/cgi-bin, alongside some "redirect" subpages. These can be safely ignored; do not place them in your curation, even though some of them 404.
  • If you have any questions/problems, ask in the #plugin-chat channel in our Discord server.

Wrapping It Up

First, make sure that you have thoroughly tested your curation and followed the Curation Format. Scroll down in the Curate tab and click the Export button at the bottom of your curation to save it as a .7z file. After you've exported the curation, you can find it by clicking the Exported Curations button on the Curate tab (as long as you didn't choose to save it somewhere else). Once you have the file, submit it to the Flashpoint Submission System. An explanation of how the site works is available here.

After you have uploaded your curation to the website, a Curator will check it. This can take some time, so please be patient. You will be pinged in the #fpfss-notifications channel about whether or not your submission was approved, and if any changes need to be made.

Congratulations! Your submitted game/animation will appear in the next version of Flashpoint.