Script Template

0 Members and 1 Guest are viewing this topic.

*
Rep:
Level 97
2014 Best RPG Maker User - Engine2014 Most Unsung Member2013 Best RPG Maker User (Scripting)2012 Favorite Staff Member2012 Most Mature Member2012 Best RPG Maker User (Scripting)2012 Best MemberSecret Santa 2012 ParticipantProject of the Month winner for July 20092011 Best RPG Maker User (Scripting)2011 Best Veteran2011 Favourite Staff Member2011 Most Mature Member2011 Best Use of Avatar and Signature Space2010 Favourite Staff Member2010 Most Mature Member
If anyone has any ideas to make it better, I will take their input into consideration and update this. Also, if any of the following categories do not fit into your script, feel free to remove them (for example, version history if your script has only one version). The only categories which are not optional is the Header, the Script (or Demo), the Features, and the Instructions.

Code: [Select]
[center][size=14pt]<Script Name>[/size]
[b][size=12pt]Version:[/size][/b] [size=12pt]<Number>[/size]
[b][size=12pt]Author:[/size][/b] [size=12pt]<The Writer's Name> (how he/she/you want to be credited)[/size]
[b][size=12pt]Date:[/size][/b] [size=12pt]<Month> <Day>, <Year> (of most recent version)[/size][/center]

[center][b][size=12pt]Version History[/size][/b][/center]
[hr]

[list]
[li]<Version A.B> YYYY.MM.DD - description of changes made to original[/li]
[li]<Version X.Y> YYYY.MM.DD - description of changes made to original[/li]
[li]<and so on for all versions (at least all released versions)>[/li]
[li]<Version 1.0> YYYY.MM.DD - Original Release[/li]
[/list]

[center][u][size=10pt]Planned Future Versions[/size][/u][/center]

[list]
[li]<Version A.B> <description of changes made to original>[/li]
[li]<Version X.Y> <description of changes made to original>[/li]
[li]<and so on for all planned versions[/li]
[/list]

[center][b][size=12pt]Description[/size][/b][/center]
[hr]

<Describe the script. Say what it does and what purpose it serves>

[center][u][size=10pt]Features[/size][/u][/center]

[list]
[li]<List the features of the script, specific things which you think will attract people>[/li]
[li]<For example, if it is a quest log, a good thing to put here would be: allows for an infinite number of quests[/li]
[li]<or: keeps track of progress through each quest with in-game variables that you set>[/li]
[li] <and so on>[/li]
[/list]

[center][u][size=10pt]Screenshots[/size][/u]

[img]<Post screenshots here if necessary or if you think it will attract people to your script>[/img]
[/center]

[center][u][size=10pt]Instructions[/size][/u][/center]

<Write down the instructions for using the script here. You can direct to the script if the instructions are inside it. Otherwise, be as detailed as necessary to make it easy for people to use your script>

[center][b][size=12pt]Script[/size][/b][/center]
[hr]

[quote]
<Post your script here, but use code tags instead of quote tags. If the script is too large, either link to a text document containing it or direct to the demo>
[/quote]

[center][b][size=12pt]Credit[/size][/b][/center]
[hr]

[list]
[li]<script author>[/li]
[li]<other script author, if applicable[/li]
[li]<and so on. Be sure to credit anyone whose script you used in your own, even if they did not directly collaborate with you>[/li]
[/list]

[center][u][size=10pt]Thanks[/size][/u][/center]

[list]
[li]<list people who you would like to thank. For instance, the person who requested the script>[/li]
[li]<or another scripter who helped you improve your scripter>[/li]
[li]<or whatever inspired you to write the script[/li]
[/list]

[center][b][size=12pt]Support[/size][/b][/center]
[hr]

<Provide contact info on where you can be found to provide support for your script. For instance, if you are a regular on another forum, provide a link to your topic there if they want swift response>

[center][u][size=10pt]Known Compatibility Issues[/size][/u][/center]

<If you know of any compatibility issues (like will not work with RTAB), post them here. Also, if you've done some compatibility fixes>

[center][b][size=12pt]Demo[/size][/b][/center]
[hr]

<If a demo is useful, provide a link to it here or if it is attached, write "See Attached" or something. If no demo exists, say why and direct to the script>

[center][b][size=12pt]Author's Notes[/size][/b][/center]
[hr]

<Anything about the script you'd like to share, such as inspiration, whatever...>

[center][b][size=12pt]Terms of Use[/size][/b][/center]
[hr]

<Any conditions you would like to place on using, distributing, or modifying your scripts. If you do not place any conditions, the Terms of Use for your script will be the default ones set out in a sticky at the top of the respective maker database. See, for instance, the [url=http://rmrk.net/index.php/topic,45481.0.html]Terms of Use for RMVXA Scripts Database[/url]>

It will show up like this:

Spoiler for:
<Script Name>
Version: <Number>
Author: <The Writer's Name> (how he/she/you want to be credited)
Date: <Month> <Day>, <Year> (of most recent version)

Version History


  • <Version A.B> YYYY.MM.DD - description of changes made to original
  • <Version X.Y> YYYY.MM.DD - description of changes made to original
  • <and so on for all versions (at least all released versions)>
  • <Version 1.0> YYYY.MM.DD - Original Release

Planned Future Versions

  • <Version A.B> <description of changes made to original>
  • <Version X.Y> <description of changes made to original>
  • <and so on for all planned versions

Description


<Describe the script. Say what it does and what purpose it serves>

Features

  • <List the features of the script, specific things which you think will attract people>
  • <For example, if it is a quest log, a good thing to put here would be: allows for an infinite number of quests
  • <or: keeps track of progress through each quest with in-game variables that you set>
  • <and so on>

Screenshots



Instructions

<Write down the instructions for using the script here. You can direct to the script if the instructions are inside it. Otherwise, be as detailed as necessary to make it easy for people to use your script>

Script


Code: [Select]
<Post your script here, but use code tags instead of quote tags. If the script is too large, either link to a text document containing it or direct to the demo>

Credit


  • <script author>
  • <other script author, if applicable
  • <and so on. Be sure to credit anyone whose script you used in your own, even if they did not directly collaborate with you>

Thanks

  • <list people who you would like to thank. For instance, the person who requested the script>
  • <or another scripter who helped you improve your scripter>
  • <or whatever inspired you to write the script

Support


<Provide contact info on where you can be found to provide support for your script. For instance, if you are a regular on another forum, provide a link to your topic there if they want swift response>

Known Compatibility Issues

<If you know of any compatibility issues (like will not work with RTAB), post them here. Also, if you've done some compatibility fixes>

Demo


<If a demo is useful, provide a link to it here or if it is attached, write "See Attached" or something. If no demo exists, say why and direct to the script>

Author's Notes


<Anything about the script you'd like to share, such as inspiration, whatever...>

Terms of Use


<Any conditions you would like to place on using, distributing, or modifying your scripts. If you do not place any conditions, the Terms of Use for your script will be the default ones set out in a sticky at the top of the respective maker database. See, for instance, the Terms of Use for RMVXA Scripts Database>
« Last Edit: April 26, 2012, 05:11:02 PM by modern algebra »

***
Rep:
Level 69
RESIDENT ADONKADONK
Must we use this template?

I'm back.

*
Rep:
Level 97
2014 Best RPG Maker User - Engine2014 Most Unsung Member2013 Best RPG Maker User (Scripting)2012 Favorite Staff Member2012 Most Mature Member2012 Best RPG Maker User (Scripting)2012 Best MemberSecret Santa 2012 ParticipantProject of the Month winner for July 20092011 Best RPG Maker User (Scripting)2011 Best Veteran2011 Favourite Staff Member2011 Most Mature Member2011 Best Use of Avatar and Signature Space2010 Favourite Staff Member2010 Most Mature Member
It's not a requirement, but it is a good guideline as to what kind of information should be given when publishing a script.

And I think it looks pretty.

But the answer to your question is no.



The only real requirement without which a script topic might be removed is that you need to make it clear who should get credit if it is used, especially if you aren't the author of the script.

Also, something that says what the script does, like a description or a screenshot is generally helpful.
« Last Edit: January 12, 2012, 01:34:13 AM by modern algebra »

*
Scripter
Rep:
Level 37
Crownless King
I would like to post my scripts here as well but may I ask a question? Is RMRK in a script to post system? By this meaning that we should post the script here. Or is it okay if we link them to our own blog or to our own website where we they can get the script in?


If you like my work, please do support me on Patreon.
https://www.patreon.com/Soulpour777?ty=h

*
Rep:
Level 97
2014 Best RPG Maker User - Engine2014 Most Unsung Member2013 Best RPG Maker User (Scripting)2012 Favorite Staff Member2012 Most Mature Member2012 Best RPG Maker User (Scripting)2012 Best MemberSecret Santa 2012 ParticipantProject of the Month winner for July 20092011 Best RPG Maker User (Scripting)2011 Best Veteran2011 Favourite Staff Member2011 Most Mature Member2011 Best Use of Avatar and Signature Space2010 Favourite Staff Member2010 Most Mature Member
If it is just a link and nothing else, then that is an advertisement, and you'd need to do it through the Poster Board. However, as long as you give a description of the script and say who to credit (and it doesn't have to match this template), then it is totally fine to link to another site when sharing the actual script. So yes, it is OK not to post the code itself on this site.
« Last Edit: January 25, 2014, 04:54:38 AM by modern algebra »