[STICKY] A short guide about how to share your custom DFN scripts

Got any custom DFN additions/tweaks you think other people would like to see? Post 'em here!
Post Reply
User avatar
Xuri
Site Admin
Posts: 3704
Joined: Mon Jun 02, 2003 9:11 am
Location: Norway
Has thanked: 48 times
Been thanked: 8 times
Contact:

A short guide about how to share your custom DFN scripts

Post by Xuri »

Have you written some custom DFN-scripts that you want to share with others? This post is a short guide on how to ideally post your custom script on these forums.

What should I ideally include in my post?
  • A Subject-line that includes a descriptive and/or unique Name for your script, to make it easy for others to identify your particular script from the rest
  • (optional) Version-number of your script in the Subject-line, very helpful if you update the script over time
  • An introduction that describes what your DFN script is for
  • Instructions - Any special considerations that people need to know? Does the script have to be setup in a specific way?
  • Syntax-Highlighting - Instead of the normal [ code ] BBCode, surround your DFN-text with the following instead: [ Codebox=uox3dfn file=Untitled.uox3dfn ][ /Codebox ] (minus the empty spaces). This will add DFN-appropriate syntax-highlighting.
Concerning file-attachments:
The forum also supports file-attachments, but this should not be exclusively relied on when posting your DFNs. Always try to include the scripts in text-form as well (contained in code or syntax tags, of course), as a form of future-proofing should the file-attachments ever go poof!. For small stand-alone scripts, it is overkill to include both the script in text-form and as a file-attachment, so please use some common sense for when to utilize this feature.

If you should ever need to do updates to your script, modify your original post with the updated version of the script, update the version number (if you have one), and post a new reply describing your changes and hinting at the updated first post. This makes it easy for anyone to get the latest version of your script, instead of potentially having to look through all the posts in the thread for updates/fixes.
-= Ho Eyo He Hum =-
Post Reply