Stencyl 3.4.0 is now out. Get it now!

Forum Template for Extensions

Jon

  • *
  • Posts: 17515
Packing up an Extension for Publication

1) ZIP it up into a folder.

2) If you’ve made a native (iOS / Android) extension, you can omit the project subfolder from the redistributed extension. This contains the source code to your extension. (Even if you intend for it to be open source, it's better practice to put the source up properly in Github.)


Publishing an Extension

1) First, announce your extension on the forums using the template below.

2) After you've received some feedback and have ironed out the bugs, edit in your extension on Github. We'll need to approve your entry for it to show up.

Engine Extensions
Toolset Extensions


Template for Extension Postings in the Forums

Our community has built up a growing collection of extensions. Some have found the experience to be uneven with regards to installation and documentation.

Let's make a concerted effort to improve the quality of extension entries in the forums by standardizing the approach and doing the minimum required for a user to get up and going right away.


What to Include

1) Describe it.
- What does your extension do? Why is it useful?
- Provide a feature list.
- Provide a screenshot or video showing off what the extension does.

2) Provide *clear* download links.
- It's OK (and recommended) to attach your extension to the forums. But provide a link inside your post. Most people will miss a forum attachment.

3) Provide adequate documentation.
- Tell users how to install the extension.
- Provide a sample game that can be immediately run.
- Document the most important features of your extension.

4) Update your post (and title) any time the extension is updated.
- If the user has to do anything to upgrade, beyond updating the extension, mention it.


Template

(See the following post to see what this looks like.)

Code: [Select]
[size=18pt][b]Name of Your Extension[/b][/size]
[i]Works on iOS, Android, Flash, Windows and Mac.[/i]

Describe the extension. What makes it useful?

[size=12pt][b]Features[/b][/size]
- A
- B
- C

(Place a video and/or screenshots here.)


[size=18pt][b]Get it[/b][/size]

- [url=http://aaa]Download this Extension[/url]
- [url=http://aaa]Sample Project[/url]

[url=http://community.stencyl.com/index.php/topic,30432.0.html](How to Install and Update an Extension)[/url]


[size=18pt][b]Documentation[/b][/size]

Either document the extension directly inside your post or link to an attached PDF file. At a minimum, explain what each of the blocks do like the following.

----------------------------------------------

[color=green][b]Name of the Block[/b][/color]
Describe what the block does.

[IMG]http://i.imgur.com/vRjyGX5.png[/img]

[b]Inputs [/b]
- Data Name (as Text)
- Value (as Number, Text, anything else)
- File Name (as Text)

[b]Returns[/b]
Either "nothing" for an action block or the value it returns if it's a normal block.

----------------------------------------------


[size=18pt][b]Version History[/b][/size]

Use this section to record updates and changes to the extension.


Examples of Good Posts

AdMob Extension

(This does all the right things. Clear documentation in a PDF, a well-formatted post, has just the right amount of info without being overwhelming.)

« Last Edit: November 02, 2015, 10:27:04 am by Jon »

Jon

  • *
  • Posts: 17515
Name of Your Extension
Works on iOS, Android, Flash, Windows and Mac.

Describe the extension. What makes it useful?

Features
- A
- B
- C

(Place a video and/or screenshots here.)


Get it

- Download this Extension
- Sample Project

(How to Install and Update an Extension)


Documentation

Either document the extension directly inside your post or link to an attached PDF file. At a minimum, explain what each of the blocks do like the following.

----------------------------------------------

Name of the Block
Describe what the block does.



Inputs
- Data Name (as Text)
- Value (as Number, Text, anything else)
- File Name (as Text)

Returns
Either "nothing" for an action block or the value it returns if it's a normal block.

----------------------------------------------


Version History

Use this section to record updates and changes to the extension.

« Last Edit: March 24, 2014, 11:46:21 am by Jon »