START HERE - EasyMOD Compliance Standards

[Nuttzy99]

NOTE: feel free to look over the EMC standards and post comments on them. I can't guarantee when I'll be able to reply until the rest of the EMC standards are written. I will post up one topic at a time. Nothing has been spell-checked, grammar checked, or even checked to make sure it makes sense so cut me some slack!!




Introduction
Ok, you've written a MOD and you want it to work as best it can with EasyMOD. You've got it to follow the MOD Template Tuturial, so does that mean it is EasyMOD Compliant (EMC)? No. EMC is a 3rd Generation Template Command Set for writing MODs, with the focus on getting the maximum number of MODs working in harmony. This means you must take care that your MOD will not be interfered with by previous MOD installations and also be sure to prevent causing interferring with future MOD installations. Every MOD Author should at the very least read the "The least you need to know" sections of each chapter".

The following will guide you every step of the way! I assume you are familiar with the MOD Template Tutorial so I will not be explaining these into the ground It is important to note that this document is only concerned with covering issues that are necessary for automation. I attempt to give the Author as much leway as possible in formatting their code. However, the phpBB MOD Team may have additional stylistic concerns. You will need to observe those requirements for entry to the phpBB.com MODs Database.


Index

1. MODing Philosophy
   
2. Order! Order!
   
3. I need (white)space!
   
4. FINDing your Way Around
   
5. Replace the REPLACE
   
6. Care to Comment?
   
7. Watch your Language
   
8. Be Style Conscious
   
9. ABOUT 4 to 6 MORE ISSUES TO GO!

-Nuttzy


edited by markus to fix links

[Nuttzy99]

bumping to top

-Nuttzy

[Nuttzy99]

Loaded 2 more! The toughest ones are done!

-Nuttzy

[Nuttzy99]

I wanted to see how long everything is if I threw it into a Word DOC file. 20 pages and counting!!!!!! I'm sure it will be even longer when formatting is improved. Plus there are a few more chapters to be added. Man my fingers are getting tired! I uploaded the file so you can check it out if you want (and yes I will be sure to use the spell checker when the times comes )

EDIT: hrmmmm...... attachments seem to not be working right now... I'll provide a link later.

EDIT2: linkage... http://users.bicnet.net/~pktoolkit/down ... OD/EMC.zip


-Nuttzy

[Jaeboy]

How about converting it into PDF? I can help!

[sevengraff]

PDF: http://sevengraff.com/nick/EMC.pdf
OOo makes PDF's a snap!

[GPHemsley]

PDF: http://sevengraff.com/nick/EMC.pdf
OOo makes PDF's a snap!

All I can say is.... WOW!

[tbartold]

This may be a stupid question but.. Here goes.

I would like to make my MOD EMC compliant, is there a way to verify this? I don't see anything like a template checker (like they have for the standard mod syntax). Any chance I juct can't find it? Any chance (assuming there is none), that you'll be putting one up?

[GPHemsley]

This may be a stupid question but.. Here goes.

I would like to make my MOD EMC compliant, is there a way to verify this? I don't see anything like a template checker (like they have for the standard mod syntax). Any chance I juct can't find it? Any chance (assuming there is none), that you'll be putting one up?

EMC standards have not even been finalized, so don't expect a validator for them for a while (if at all). If you follow all of the rules posted, AND your MOD installs fine in a vanilla board, you're probably very close to EMC. Always test in many setups, with many other MODs installed, and always listen to any errors your users may have while installing your MOD with EasyMOD.

[A MOD's Enemy]

I have looked at all of the EMC standards and (believe it or not) my MOD complies with all of them! Here is the actions of the MOD (I am not giving out the whole MOD because it is not yet at version 1.0 and would give some stuff away that myself and the other author are not ready to give away yet!):

Code: Select all

#
#-----[ COPY ]------------------------------------------
#
copy phpbb_widget.php to phpbb_widget.php
copy phpbb_widget_badge.jpg to templates/subSilver/images/phpbb_widget_badge.jpg
#
#-----[ OPEN ]------------------------------------------
#
templates/subSilver/overall_footer.tpl
#
#-----[ FIND ]------------------------------------------
#
// -->
#
#-----[ AFTER, ADD ]------------------------------------------
#
<a href="http://www.widgetgallery.com" target="_blank"><img src="templates/subSilver/images/phpbb_widget_badge.jpg" /></a><br>
#
#-----[ SAVE/CLOSE ALL FILES ]------------------------------------------
#
# EoM

Though this MOD still isn't at 1.0 yet, most of the bug testing has been complete and we do not expect the install.txt file for 1.0 to be much different than this. Any changes that would happen would most likely be PHP code changes in phpbb_widget.php. This MOD has also been thoroughly tested in EasyMOD 0.1.13 Beta 1 (the leatest version as of this post) and works great on a board with 12 other MODs installed at this time.

Does this mean that this MOD is officially EMC? If it is not, what should I do to make it EMC? If it is, what should I do to state that it is EMC?