Extension Guide/Reference: info.txt
This little post is designed as a guide and a reference to the features of info.txt in engine extensions.
What is this info.txt thing?
When you open any extension folder, you should see a file titled info.txt
inside. This file is important because it controls the name of the extension, along with the current version number, compatible publishing platforms, and a few other things. Here's an example, taken from the built-in Test Extension:
description=A test extension
Now, here's a basic rundown of each of these items:name
- The name of the extension, displayed in Settings -> Extensions
and the Extensions section of the block palette.description
- A brief description of the extension, also displayed in Settings -> Extensions
- The name or username of the extension's author.website
- If the user right-clicks an extension block and presses View Help
, this is the webpage to which they are taken. Make sure that users can view the extension's documentation on this page. Linking to the forum topic is usually a good choice.version
- Doesn't do anything special, but useful for keeping track of the latest version. Users can see it in the Log Viewer right after Stencyl is opened.compatibility
- Controls the publishing platforms for which the extension will compile. This can currently have the following values:
Using more than one of these (e.g. flash and ios
) is not currently supported.Note:
all of these fields are required, and each field has to be on its own line; you can't do something like this:
name=Test Extension description=A test extension author=Jon website=http://www.stencyl.com version=1.0 compatibility=all
And that's pretty much all you need to know about info.txt
. Please post below if you have questions, comments or suggestions. Also, check out the Guide/Reference for Creating Extension Blocks
for more extension-y goodness!