Thread: [Boardmod-devel] boardmod HowTo.html,NONE,1.1.2.1
Brought to you by:
michaelprager,
t-master
From: <mic...@us...> - 2002-12-23 16:42:44
|
Update of /cvsroot/boardmod/boardmod In directory sc8-pr-cvs1:/tmp/cvs-serv27184 Added Files: Tag: BoardMod25-branch HowTo.html Log Message: added new howto file --- NEW FILE: HowTo.html --- <html><body> <table border="0" cellpadding="0" cellspacing="0"><tr><td bgcolor="#000000"> <table border="0" cellpadding="0" cellspacing="1"><tr><td bgcolor="#FFFFFF" valign="middle"> <table border=0 cellpadding=0 cellspacing=0> <tr> <td width="2" height="2" bgcolor=#80d956></td> <td width="2" height="2" bgcolor=#4f992d></td> <td width="2" height="2" bgcolor=#4c882d></td> <td width="2" height="2" bgcolor=#4c972d></td> <td width="2" height="2" bgcolor=#4c9e2d></td> <td width="2" height="2" bgcolor=#4ca82d></td> <td width="2" height="2" bgcolor=#4cae2d></td> <td width="2" height="2" bgcolor=#4cb42d></td> <td width="2" height="2" bgcolor=#4cb62d></td> <td width="2" height="2" bgcolor=#6cce2d></td> <td width="2" height="2" bgcolor=#7ade2d></td> <td width="2" height="2" bgcolor=#4dc42d></td> <td width="2" height="2" bgcolor=#4cc32d></td> <td width="2" height="2" bgcolor=#4cc92d></td> <td width="2" height="2" bgcolor=#4fc32d></td> <td width="2" height="2" bgcolor=#80e256></td> </tr> <tr> <td width="2" height="2" bgcolor=#4f9a2d></td> <td width="2" height="2" bgcolor=#071b00></td> <td width="2" height="2" bgcolor=#040f00></td> <td width="2" height="2" bgcolor=#051600></td> <td width="2" height="2" bgcolor=#041d00></td> <td width="2" height="2" bgcolor=#042a00></td> <td width="2" height="2" bgcolor=#044200></td> <td width="2" height="2" bgcolor=#044600></td> <td width="2" height="2" bgcolor=#044d00></td> <td width="2" height="2" bgcolor=#047800></td> <td width="2" height="2" bgcolor=#198c00></td> <td width="2" height="2" bgcolor=#4dbb00></td> <td width="2" height="2" bgcolor=#1eab00></td> <td width="2" height="2" bgcolor=#048e00></td> <td width="2" height="2" bgcolor=#077800></td> <td width="2" height="2" bgcolor=#4fbe2d></td> </tr> <tr> <td width="2" height="2" bgcolor=#4c7d2d></td> <td width="2" height="2" bgcolor=#0b2300></td> <td width="2" height="2" bgcolor=#328500></td> <td width="2" height="2" bgcolor=#54a800></td> <td width="2" height="2" bgcolor=#2c9300></td> <td width="2" height="2" bgcolor=#1f7f00></td> <td width="2" height="2" bgcolor=#054300></td> <td width="2" height="2" bgcolor=#045000></td> <td width="2" height="2" bgcolor=#30ad00></td> <td width="2" height="2" bgcolor=#44ca00></td> <td width="2" height="2" bgcolor=#027900></td> <td width="2" height="2" bgcolor=#179f00></td> <td width="2" height="2" bgcolor=#a2ed00></td> <td width="2" height="2" bgcolor=#71d100></td> <td width="2" height="2" bgcolor=#0c8800></td> <td width="2" height="2" bgcolor=#4ccb2d></td> </tr> <tr> <td rowspan="2" colspan="1" width="2" height="2" bgcolor=#4c752d></td> <td width="2" height="2" bgcolor=#091e00></td> <td width="2" height="2" bgcolor=#1e7400></td> <td width="2" height="2" bgcolor=#4ea400></td> <td width="2" height="2" bgcolor=#68ba00></td> <td width="2" height="2" bgcolor=#35ab00></td> <td width="2" height="2" bgcolor=#2ca800></td> <td width="2" height="2" bgcolor=#075a00></td> <td width="2" height="2" bgcolor=#55d100></td> <td width="2" height="2" bgcolor=#4ed800></td> <td width="2" height="2" bgcolor=#169c00></td> <td width="2" height="2" bgcolor=#1cae00></td> <td width="2" height="2" bgcolor=#4fe200></td> <td width="2" height="2" bgcolor=#63e300></td> <td width="2" height="2" bgcolor=#67d900></td> <td width="2" height="2" bgcolor=#64de2d></td> </tr> <tr> <td width="2" height="2" bgcolor=#061600></td> <td width="2" height="2" bgcolor=#0a5300></td> <td width="2" height="2" bgcolor=#5bac00></td> <td width="2" height="2" bgcolor=#a2d500></td> <td width="2" height="2" bgcolor=#4fb700></td> <td width="2" height="2" bgcolor=#74d000></td> <td width="2" height="2" bgcolor=#0f5700></td> <td width="2" height="2" bgcolor=#54d000></td> <td width="2" height="2" bgcolor=#3bce00></td> <td width="2" height="2" bgcolor=#2fb800></td> <td width="2" height="2" bgcolor=#28ba00></td> <td width="2" height="2" bgcolor=#31d700></td> <td width="2" height="2" bgcolor=#26d400></td> <td width="2" height="2" bgcolor=#08a900></td> <td width="2" height="2" bgcolor=#89e92d></td> </tr> <tr> <td rowspan="5" colspan="1" width="2" height="2" bgcolor=#4c742d></td> <td width="2" height="2" bgcolor=#041300></td> <td width="2" height="2" bgcolor=#086a00></td> <td width="2" height="2" bgcolor=#2faa00></td> <td width="2" height="2" bgcolor=#37a000></td> <td width="2" height="2" bgcolor=#40ab00></td> <td width="2" height="2" bgcolor=#bae500></td> <td width="2" height="2" bgcolor=#0e7e00></td> <td width="2" height="2" bgcolor=#3dc800></td> <td width="2" height="2" bgcolor=#34c800></td> <td width="2" height="2" bgcolor=#3fc300></td> <td width="2" height="2" bgcolor=#39be00></td> <td width="2" height="2" bgcolor=#53e400></td> <td width="2" height="2" bgcolor=#3bd600></td> <td width="2" height="2" bgcolor=#049800></td> <td width="2" height="2" bgcolor=#4cd02d></td> </tr> <tr> <td width="2" height="2" bgcolor=#040e00></td> <td width="2" height="2" bgcolor=#017b00></td> <td width="2" height="2" bgcolor=#048700></td> <td width="2" height="2" bgcolor=#097400></td> <td width="2" height="2" bgcolor=#39c700></td> <td width="2" height="2" bgcolor=#459500></td> <td width="2" height="2" bgcolor=#0a6200></td> <td width="2" height="2" bgcolor=#8ee000></td> <td width="2" height="2" bgcolor=#64db00></td> <td width="2" height="2" bgcolor=#39ca00></td> <td width="2" height="2" bgcolor=#3ac800></td> <td width="2" height="2" bgcolor=#84f100></td> <td width="2" height="2" bgcolor=#50df00></td> <td width="2" height="2" bgcolor=#049000></td> <td width="2" height="2" bgcolor=#4cc02d></td> </tr> <tr> <td width="2" height="2" bgcolor=#040c00></td> <td width="2" height="2" bgcolor=#008c00></td> <td width="2" height="2" bgcolor=#007400></td> <td width="2" height="2" bgcolor=#006b00></td> <td width="2" height="2" bgcolor=#01af00></td> <td width="2" height="2" bgcolor=#014c00></td> <td width="2" height="2" bgcolor=#062200></td> <td width="2" height="2" bgcolor=#82dd00></td> <td width="2" height="2" bgcolor=#9ce700></td> <td width="2" height="2" bgcolor=#64db00></td> <td width="2" height="2" bgcolor=#1acc00></td> <td width="2" height="2" bgcolor=#39f500></td> <td width="2" height="2" bgcolor=#2edb00></td> <td width="2" height="2" bgcolor=#047900></td> <td width="2" height="2" bgcolor=#4cc52d></td> </tr> <tr> <td width="2" height="2" bgcolor=#040b00></td> <td width="2" height="2" bgcolor=#008f00></td> <td width="2" height="2" bgcolor=#00cb00></td> <td width="2" height="2" bgcolor=#00b900></td> <td width="2" height="2" bgcolor=#00b700></td> <td width="2" height="2" bgcolor=#00b400></td> <td width="2" height="2" bgcolor=#013100></td> <td width="2" height="2" bgcolor=#2fde00></td> <td width="2" height="2" bgcolor=#68e600></td> <td width="2" height="2" bgcolor=#87eb00></td> <td width="2" height="2" bgcolor=#8fea00></td> <td width="2" height="2" bgcolor=#41ef00></td> <td width="2" height="2" bgcolor=#0ad300></td> <td width="2" height="2" bgcolor=#046d00></td> <td width="2" height="2" bgcolor=#4cc02d></td> </tr> <tr> <td width="2" height="2" bgcolor=#040a00></td> <td width="2" height="2" bgcolor=#007200></td> <td width="2" height="2" bgcolor=#08d900></td> <td width="2" height="2" bgcolor=#056000></td> <td width="2" height="2" bgcolor=#00b500></td> <td width="2" height="2" bgcolor=#00dc00></td> <td width="2" height="2" bgcolor=#006400></td> <td width="2" height="2" bgcolor=#01de00></td> <td width="2" height="2" bgcolor=#12e000></td> <td width="2" height="2" bgcolor=#7af100></td> <td width="2" height="2" bgcolor=#b6f000></td> <td width="2" height="2" bgcolor=#b0f200></td> <td width="2" height="2" bgcolor=#5be000></td> <td width="2" height="2" bgcolor=#077100></td> <td width="2" height="2" bgcolor=#4cbf2d></td> </tr> <tr> <td width="2" height="2" bgcolor=#4c762d></td> <td width="2" height="2" bgcolor=#040900></td> <td width="2" height="2" bgcolor=#006600></td> <td width="2" height="2" bgcolor=#03d300></td> <td width="2" height="2" bgcolor=#076200></td> <td width="2" height="2" bgcolor=#0ac200></td> <td width="2" height="2" bgcolor=#02ec00></td> <td width="2" height="2" bgcolor=#006e00></td> <td width="2" height="2" bgcolor=#00d600></td> <td width="2" height="2" bgcolor=#01c000></td> <td width="2" height="2" bgcolor=#1ff700></td> <td width="2" height="2" bgcolor=#79ee00></td> <td width="2" height="2" bgcolor=#bcf400></td> <td width="2" height="2" bgcolor=#ccf400></td> <td width="2" height="2" bgcolor=#21a700></td> <td width="2" height="2" bgcolor=#4cbe2d></td> </tr> <tr> <td width="2" height="2" bgcolor=#4c7d2d></td> <td width="2" height="2" bgcolor=#040c00></td> <td width="2" height="2" bgcolor=#037f00></td> <td width="2" height="2" bgcolor=#06d500></td> <td width="2" height="2" bgcolor=#049e00></td> <td width="2" height="2" bgcolor=#31dd00></td> <td width="2" height="2" bgcolor=#25da00></td> <td width="2" height="2" bgcolor=#027700></td> <td width="2" height="2" bgcolor=#00e000></td> <td width="2" height="2" bgcolor=#00a400></td> <td width="2" height="2" bgcolor=#08f400></td> <td width="2" height="2" bgcolor=#0add00></td> <td width="2" height="2" bgcolor=#86e200></td> <td width="2" height="2" bgcolor=#d0f800></td> <td width="2" height="2" bgcolor=#47c800></td> <td width="2" height="2" bgcolor=#4cd22d></td> </tr> <tr> <td width="2" height="2" bgcolor=#4c942d></td> <td width="2" height="2" bgcolor=#042700></td> <td width="2" height="2" bgcolor=#0a9b00></td> <td width="2" height="2" bgcolor=#0ebd00></td> <td width="2" height="2" bgcolor=#16c600></td> <td width="2" height="2" bgcolor=#33d500></td> <td width="2" height="2" bgcolor=#137900></td> <td width="2" height="2" bgcolor=#249e00></td> <td width="2" height="2" bgcolor=#1fe200></td> <td width="2" height="2" bgcolor=#0b9a00></td> <td width="2" height="2" bgcolor=#17e000></td> <td width="2" height="2" bgcolor=#0cc600></td> <td width="2" height="2" bgcolor=#3dc000></td> <td width="2" height="2" bgcolor=#70e800></td> <td width="2" height="2" bgcolor=#34c000></td> <td rowspan="2" colspan="1" width="2" height="2" bgcolor=#4cd52d></td> </tr> <tr> <td width="2" height="2" bgcolor=#4cb32d></td> <td width="2" height="2" bgcolor=#045e00></td> <td width="2" height="2" bgcolor=#088400></td> <td width="2" height="2" bgcolor=#0ca400></td> <td width="2" height="2" bgcolor=#1aac00></td> <td width="2" height="2" bgcolor=#087700></td> <td width="2" height="2" bgcolor=#002e00></td> <td width="2" height="2" bgcolor=#076900></td> <td width="2" height="2" bgcolor=#0a8100></td> <td width="2" height="2" bgcolor=#067600></td> <td width="2" height="2" bgcolor=#066f00></td> <td width="2" height="2" bgcolor=#026800></td> <td width="2" height="2" bgcolor=#138900></td> <td width="2" height="2" bgcolor=#0f7b00></td> <td width="2" height="2" bgcolor=#047000></td> </tr> <tr> <td width="2" height="2" bgcolor=#4fc22d></td> <td width="2" height="2" bgcolor=#077500></td> <td width="2" height="2" bgcolor=#046800></td> <td width="2" height="2" bgcolor=#047e00></td> <td width="2" height="2" bgcolor=#049700></td> <td width="2" height="2" bgcolor=#049400></td> <td width="2" height="2" bgcolor=#048b00></td> <td width="2" height="2" bgcolor=#04a000></td> <td width="2" height="2" bgcolor=#049d00></td> <td width="2" height="2" bgcolor=#04a600></td> <td width="2" height="2" bgcolor=#048700></td> <td width="2" height="2" bgcolor=#048e00></td> <td width="2" height="2" bgcolor=#048d00></td> <td width="2" height="2" bgcolor=#047300></td> <td width="2" height="2" bgcolor=#078a00></td> <td width="2" height="2" bgcolor=#4fdd2d></td> </tr> <tr> <td width="2" height="2" bgcolor=#80e656></td> <td width="2" height="2" bgcolor=#4fc72d></td> <td width="2" height="2" bgcolor=#4cc42d></td> <td rowspan="1" colspan="2" width="2" height="2" bgcolor=#4ccf2d></td> <td width="2" height="2" bgcolor=#4cd12d></td> <td width="2" height="2" bgcolor=#4cdc2d></td> <td rowspan="1" colspan="2" width="2" height="2" bgcolor=#4cdf2d></td> <td width="2" height="2" bgcolor=#4ce32d></td> <td width="2" height="2" bgcolor=#4ce52d></td> <td width="2" height="2" bgcolor=#4ce32d></td> <td width="2" height="2" bgcolor=#4cde2d></td> <td width="2" height="2" bgcolor=#4cdc2d></td> <td width="2" height="2" bgcolor=#4fe62d></td> <td width="2" height="2" bgcolor=#80f556></td> </tr> </table> </td><td bgcolor="#FFFFFF" valign="middle"><font face="verdana" size="5"><b><nobr> How To Write Mod Files </nobr></b></font></td></tr></table></td></tr></table> <font face="verdana" size="1">Ver 1.0.1 from 1. Sept 2002, written by Michael Prager</font> <h2><a name="Top"></a>The Basics</h2> <ol start="1" type="I"> <li><a href="#General File Structure">General File Structure</a></li> <li><a href="#Available Tags">Available Tags</a></li> <li><a href="#Example">Complete Example of a .mod File</a></li> <li><a href="#Limits">Limitations</a></li> </ol> <h2>Advanced Rules</h2> <ol start="4" type="I"> <li><a href="#filenames">Filenames</a></li> <li><a href="#ID">ID</a></li> <li><a href="#Version">Version</a></li> <li><a href="#Mod Info">Mod Info</a></li> <li><a href="#Author">Author</a></li> <li><a href="#Homepage">Homepage</a></li> </ol> <h2>Links</h2> <ol start="10" type="I"> <li><a href="#Comments">Comments</a></li> </ol> <br><hr size="1" color="#000000" width="100%"> <br><h1>The Basics</h1> <ol start="1" type="I"> <a name="General File Structure"></a><h2><li>General File Structure</li></h2> <p>Before we look into the rules of mod writing, we first have to get an idea of what a <i>mod</i> is. In general a <i>mod</i> is nothing else than instructions like <i>"look for this text line(s) in file X"</i> and <i>"replace it with this text line(s)"</i> stored in a single ASCII text file. Mod files have the extension <i>".mod"</i> and can have any name. The file format looks like HTML or XML (but it is NOT equal). You have several "tags" available which can surround something, just like brackets.</p> <p><table border="0" cellpadding="1" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellpadding="8" cellspacing="0"><tr><td bgcolor="#FFFFFF"><h3>Example</h3><code><Mod info><br>This is a test and does nothing<br></Mod info></code></td></tr></table></td></tr></table></p> <p>However there is a big difference to XML and HTML: You are not allowed to write tags like this:</p> <p><table border="0" cellpadding="1" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellpadding="8" cellspacing="0"><tr><td bgcolor="#FFFFFF"><h3>This does not work:</h3><code><Mod info>This is a test and does nothing</Mod info></code></td></tr></table></td></tr></table></p> <p>You have to put a linebreak after and before each tag!</p> <p>Another thing you have to know is that some tags only allow one line! Please see the <a href="#Available Tags">tag list</a> for which tags are "multi-line" and which are not.</p> <p><a href="#Top">back to top</a></p> <a name="Available Tags"></a><h2><li>Available Tags</li></h2> <p>Right now, there are 10 different tags available:</p> <p><table border="0" cellpadding="0" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellspacing="1" cellpadding="4"> <tr><td bgcolor="#000000"><font color="#FFFFFF">Tag</font></td><td bgcolor="#000000"><font color="#FFFFFF">Description</font></td><td bgcolor="#000000"><font color="#FFFFFF"><nobr>Multi-line*</nobr></font></td></tr> <tr><td bgcolor="#FFFFFF"><code><ID></code></td><td bgcolor="#FFFFFF">This is the name of the mod</td><td bgcolor="#FFFFFF">No</td></tr> <tr><td bgcolor="#FFFFFF"><code><Version></code></td><td bgcolor="#FFFFFF">Mod version</td><td bgcolor="#FFFFFF">No</td></tr> <tr><td bgcolor="#FFFFFF"><nobr><code><Mod info></code></nobr></td><td bgcolor="#FFFFFF">Mod description and information like instructions, features, version history and additional credits</td><td bgcolor="#FFFFFF">Yes</td></tr> <tr><td bgcolor="#FFFFFF"><code><Author></code></td><td bgcolor="#FFFFFF">Here you can put your name</td><td bgcolor="#FFFFFF">No</td></tr> <tr><td bgcolor="#FFFFFF"><code><Homepage></code></td><td bgcolor="#FFFFFF">If you have a homepage or emial address, you can put it in here</td><td bgcolor="#FFFFFF">No</td></tr> <tr><td bgcolor="#FFFFFF"><nobr><code><Edit file></code></nobr></td><td bgcolor="#FFFFFF">Specifies a file which will be modified. The file path is always relative to the main script file (e.g. YaBB.pl)"</td><td bgcolor="#FFFFFF">No</td></tr> <tr><td bgcolor="#FFFFFF"><nobr><code><Search for></code></nobr></td><td bgcolor="#FFFFFF">One or more lines to search for in the file specified before with <code><Edit file></code></td><td bgcolor="#FFFFFF">Yes</td></tr> <tr><td bgcolor="#FFFFFF"><code><Replace></code></td><td bgcolor="#FFFFFF">Replaces the line/lines specified by <code><Search for></code> by one or more other lines</td><td bgcolor="#FFFFFF">Yes</td></tr> <tr><td bgcolor="#FFFFFF"><nobr><code><Add before></code></nobr></td><td bgcolor="#FFFFFF">Adds one or more lines before those which had been searched by <code><Search for></code></td><td bgcolor="#FFFFFF">Yes</td></tr> <tr><td bgcolor="#FFFFFF"><nobr><code><Add after></code></nobr></td><td bgcolor="#FFFFFF">Adds one or more lines after those which had been searched by <code><Search for></code></td><td bgcolor="#FFFFFF">Yes</td></tr> </table></td></tr></table> * Only tags which are "multi-line" allow more than one line</p> <p><a href="#Top">back to top</a></p> <a name="Example"></a><h2><li>Complete Example of a .mod File</li></h2> <p>Here is an example of a .mod file. Please visit <a href="http://mods.boardmod.org">mods.boardmod.org<a> for more examples.</p> <p><table border="0" cellpadding="1" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellpadding="8" cellspacing="0"><tr><td bgcolor="#FFFFFF"><code> <ID><br> Example Mod<br> </ID><br> <br> <version><br> 0.1 Alpha<br> </version><br> <br> <Mod info><br> This is an example mod to demonstrate the possibilities<br> of the mod format. Please note that this mod is NOT made to<br> be applied to anything. It's just an example!<br> </Mod info><br> <br> <author><br> Mr.X<br> </author><br> <br> <homepage><br> http://www.mr_x.com<br> </homepage><br> <br> <Edit file><br> Sources\Display.pl<br> </Edit file><br> <br> <Search for><br> if($signature ne "") {<br> $signature = "<br>-----------------<br>$signature";<br> }<br> </Search for><br> <br> <Replace><br> if($memset[5] eq "\n"){<br> $signature= "";<br> } else {<br> $signature= "<hr size=1 noshade width=40\% align=left>$signature";<br> }<br> </Replace><br> <br> <Search for><br> $signature= "<hr size=1 noshade width=40\% align=left>$signature";<br> </Search for><br> <br> <Add before><br> #Example modification<br> </Add before><br> <br> //////////////////////////////////////////////////////<br> Outside the brackets you can write what you want! The BoardMod will ignore these lines...<br> \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\<br> <br> <Edit file><br> Sources\ModifyMessage.pl<br> </Edit file><br> <br> <Search for><br> print FILE "$subject\|$mname[$x]\|$memail[$x]\|$date\|$musername[$x]\|$icon\|0\|$ENV{REMOTE_ADDR}\|$message\n";<br> </Search for><br> <br> <Add after><br> $dpmsgs[$dpmsgsc] = "$dpthreadb|$dpsub|$dprn|$dpem|$date|$dprc|$dpun|$dpic|$dpuk\n";<br> open(TN, ">$boardsdir/$currentboard.txt");<br> &lock(TN);<br> </Add after><br> </code></td></tr></table></td></tr></table></p> <p><a href="#Top">back to top</a></p> <a name="Limits"></a><h2><li>Limitations</li></h2> <p>Currently there is a very important limitation you have to know about: <B>It is only possible to search for complete lines, not for single words!</b> Always keep this in mind when writing your mods. This is very important when you want to search for some lines which start with spaces or tabs. Leaving them out in the <code><search for></code> tag will make your mod not working.</p> <p><table border="0" cellpadding="1" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellpadding="8" cellspacing="0"><tr><td bgcolor="#FFFFFF"><h3>Example</h3><code><search for><br>for i := 1 to 10 do begin<br> b := b * z + 1;<br></search for></code><br><br>is NOT equal to<br><br><code><search for><br> for i := 1 to 10 do begin<br> b * z + 1;<br></search for></code></td></tr></table></td></tr></table></p> <p>Another limitation is that empty <code><replace></code> tags are not allowed. So for example the code to remove a line does not look like this:</p> <p><table border="0" cellpadding="1" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellpadding="8" cellspacing="0"><tr><td bgcolor="#FFFFFF"><h3>This does not work</h3><code><replace><br></replace></code><br><br>or<br><br><code><replace><br><br></replace></code></td></tr></table></td></tr></table></p> <p><table border="0" cellpadding="1" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellpadding="8" cellspacing="0"><tr><td bgcolor="#FFFFFF"><h3>Instead use this code</h3><code><search for><br>i := i * i + 1;<br>i := i - 1;<br></search for><br><br><replace><br>i := i * i + 1;<br></replace></code></td></tr></table></td></tr></table></p> <p>The reason for this limitation is to keep all steps "undoable". This is required to provide uninstall ability.</p> <p><a href="#Top">back to top</a></p> </ol> <br><br><h1>Advanced Rules</h1> <ol start="4" type="I"> <a name="filenames"></a><h2><li>Filenames</li></h2> <p>The <b>.mod</b> filename should be equal to the mod name (<code><id></code> tag) to prevent confusion and to make sure that the filename is unique. In addition there are some additional standarts we use for our mods at YaBB to keep everything "uniform": spaces are replaced by "_" (underscore). If the mod version is not 1.0 then the version should be added to the filename too but without the dots. Do this to avoid problems when people have multiple versions of the mod in the same folder. Look at the example to get an idea of it.</p> <p><table border="0" cellpadding="1" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellpadding="8" cellspacing="0"><tr><td bgcolor="#FFFFFF"><h3>Example</h3>If the modname is <i>"The Great Mod"</i> and its version is <i>"2.55a"</i> then the filename would be <i>"the_great_mod_255a.mod"</i>.</td></tr></table></td></tr></table></p> <p>If you compress your mod as a <b>.zip</b> file (e.g. if your mod comes with some additional files), you should give your .zip file the same name as the .mod file.</p> <p><table border="0" cellpadding="1" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellpadding="8" cellspacing="0"><tr><td bgcolor="#FFFFFF"><h3>Example</h3>If you pack <i>"the_great_mod_255a.mod"</i>, the .zip name would be <i>"the_great_mod_255a.zip"</i>.</td></tr></table></td></tr></table></p> <p><a href="#Top">back to top</a></p> <a name="ID"></a><h2><li>ID</li></h2> <p>This is a very important tag, its content will be used in the <a href="http://mods.boardmod.org">mod database</a> and people have to identify the mod by this name so please pay attention to it. The general rules are:<br> Keep the name short but not too short, using up to 5 words is fine. <b>Please give the mod a descriptive name!</b> Names like <i>"MEGA Super Mod by www.xy.com!!!"</i> won't help anyone.</p> <p><a href="#Top">back to top</a></p> <a name="Version"></a><h2><li>Version</li></h2> <p>Normaly a version number has a structure like <i>"1.0.1.2"</i> but you are very free here. For example you could use <i>"1.0"</i>, <i>"2.55b"</i> or even <i>"beta1"</i>.</p> <p><a href="#Top">back to top</a></p> <a name="Mod Info"></a><h2><li>Mod Info</li></h2> <p>This is THE tag so take yourself some time on this one.</p> <ul type="disc" > <li>First you should write a short description of the mod. Make it as informative as possible since people normaly only read the first few lines when browsing through the mod list.</li> <li>After this description a short list of features is a good thing.</li> <li>If your mod comes with additional files, make sure to mention this and give instructions on how to install the mod completely (what files to upload where, CHMOD, ASCII or Bin...).</li> <li>If your mod comes with a readme.txt, mention this uppercase. Some people will miss those information otherwise.</li> <li>Finally a version history should be there if any.</li> <li>anything else like additional credits...</li> </ul> <p><a href="#Top">back to top</a></p> <a name="Author"></a><h2><li>Author</li></h2> <p>Don't forget that this tag does only support one line so only use one. If there are multiple authors then list them with commas. If you release a new version of a mod which you did not originally create, please leave the author tag alone and put your your stuff at the end of the description tag (<code><Mod info></code>) instead.</p> <p><b>BTW: Never release a new version of a mod which you did not originally create, ask the original author first. Otherwise you may violate his copyright!</b></p> <p><a href="#Top">back to top</a></p> <a name="Homepage"></a><h2><li>Homepage</li></h2> <p>Same thing as with the <code><author></code> tag: only one line is supported. Leave the author's original address in there and put yours in the description if you are not the original author. Don't use commas here since BoardMod will use this as link.</p> <p>Tip: You can also put your email address in here if you don't have a webpage.</p> <p><table border="0" cellpadding="1" cellspacing="0"><tr><td bgcolor="#000000"><table border="0" cellpadding="8" cellspacing="0"><tr><td bgcolor="#FFFFFF"><h3>Example</h3><code><homepage><br>mailto:X_...@gm...<br></homepage></code></td></tr></table></td></tr></table></p> <p><a href="#Top">back to top</a></p> </ol> <br><br><h1>Links</h1> <ol start="10" type="I"> <a name="Comments"></a><h2><li>Comments</li></h2> <p>If you find any misstakes or if you want to comment anything on here, please follow <a href="http://boardmod.yabbforum.com/yabb/YaBB.pl?board=feedback;action=display;num=1033487437">this link</a> or email to <a href="mailto:fee...@bo...">fee...@bo...</a></p> <p><a href="#Top">back to top</a></p> </ol> <br><hr size="1" color="#000000" width="100%"> <code>This file is part of BoardMod. Visit <a href="http://www.boardmod.org">http://www.boardmod.org</a> for more information. </code> </body></html> |