Installing New Modules - Revision history

Hakaku at 03:37, 11 July 2009

2009-07-11T03:37:57Z

Mine GO BOOM: Reverted edits by AcoucAricc (Talk); changed back to last version by Smong

2008-07-13T04:38:22Z

Reverted edits by AcoucAricc (Talk); changed back to last version by Smong

AcoucAricc: olositzel

2008-07-13T02:59:29Z

olositzel

Smong: /* Using the ASSS Makefile */ updated for 1.4.3

2006-07-26T17:32:38Z

‎Using the ASSS Makefile: updated for 1.4.3

Smong: /* Step 3 */ updated sscx link

2006-07-16T11:12:23Z

‎Step 3: updated sscx link

Smong: Reverted edit of Zc321, changed back to last version by Smong

2006-01-15T11:14:13Z

Reverted edit of Zc321, changed back to last version by Smong

Show changes

Zc321 at 07:23, 30 November 2005

2005-11-30T07:23:15Z

Show changes

Smong: minor formatting adjustment. someone might want to learn wiki and reformat it.

2005-07-18T19:46:24Z

minor formatting adjustment. someone might want to learn wiki and reformat it.

Smong: /* With Dev C++ */ wrote content

2005-07-18T19:43:20Z

‎With Dev C++: wrote content

Cyan~Fire: /* Configuring */ wikilink

2005-05-31T12:40:08Z

‎Configuring: wikilink

@@ Line 145: / Line 145: @@
 <br><br><br><br>
 <br><br><br><br>
 === With MSVC ===

← Older revision		Revision as of 04:38, 13 July 2008
Line 1:		Line 1:
−	~~orolobasrac~~
	When you want to add more functionality to your server you can install new custom modules. Differences in server versions often mean something will break in a module, compiling from source can help fix this.		When you want to add more functionality to your server you can install new custom modules. Differences in server versions often mean something will break in a module, compiling from source can help fix this.

← Older revision		Revision as of 02:59, 13 July 2008
Line 1:		Line 1:
		+	orolobasrac
	When you want to add more functionality to your server you can install new custom modules. Differences in server versions often mean something will break in a module, compiling from source can help fix this.		When you want to add more functionality to your server you can install new custom modules. Differences in server versions often mean something will break in a module, compiling from source can help fix this.

@@ Line 3: / Line 3: @@
 == C modules ==
-=== Using the ASSS Makefile ===
+=== Using Makefile fragments ===
-The Makefile distributed with ASSS is designed to allow adding new code to it easily. This is probably the easiest way to get a new module compiling, because all the correct compiler flags are supplied for you.
+This is probably the easiest way to get a new module compiling under linux. Let's call <tt>*.mk</tt> files "Makefile fragments". All the correct compiler flags and such are supplied for you since the Makefile fragments are in included into the main Makefile.
-Create a directory for your module as a subdirectory of <tt>src</tt>, the directory containing all the ASSS code.
+This example will demonstrate how to create a shared library <tt>example.so</tt> containing two modules <tt>moo</tt> and <tt>lala</tt>. Create a directory for your module as a subdirectory of <tt>src</tt>, the directory containing all the ASSS code.
 <pre>
-$ cd asss-1.3.5/src
+$ cd asss-1.4.3/src
-$ mkdir mymod
+$ mkdir example
 </pre>
-Create a <tt>mymod.mk</tt> file within that directory that looks like this:
+Place your source code <tt>moo.c</tt> and <tt>lala.c</tt> into this newly created directory. Then create a file called <tt>example.mk</tt> within that directory that looks like this:
 <pre>
-mymod/mymod.$(SO): mymod/mymod.o
+example_mods = moo lala
 </pre>
-All <tt>*.mk</tt> files (let's call them "Makefile fragments") in any subdirectories will be included by the big Makefile automatically. Two fragments come in the contrib directory in the ASSS package, which you might want to look at as examples.
+All <tt>*.mk</tt> files in any subdirectories will be included during compilation. Two fragments come in the <tt>contrib</tt> and <tt>turf</tt> directories of the ASSS package, which you might want to look at as examples.
-Note that we use a Makefile variable, <tt>$(SO)</tt>, instead of typing <tt>.so</tt> directly. That's so that the same Makefile works on windows, where modules have to be named <tt>mymod.dll</tt> instead of <tt>mymod.so</tt>. Also note that all the filenames have to be prefixed with the directory they're in. That's because make considers all files relative to the directory it runs in.
+Now before we can compile the module we need to update the "deps". Make sure you are in the <tt>src</tt> directory.
 <pre>
-$ make mymod/mymod.so
+$ cd ..
-... compiler output ...
+$ pwd
-$ install mymod/mymod.so ../bin
+asss-1.4.3/src
 </pre>
-Note that you have to specify the target name manually; it won't get built or copy by default if you just type <tt>make</tt>. If you do want your custom module to get built and copied automatically, along with the rest of ASSS, when you type just <tt>make</tt>, add this line at the top of the Makefile fragment:
+Finally we can compile it, this step will automatically install it to the bin directory:
 <pre>
-ALL_STUFF += mymod/mymod.$(SO)
+$ make
 </pre>
-Also note that you can list more than one <tt>.o</tt> file on the line. All will be compiled into the same shared library.
+The module specifier for the new modules will be <tt>example:moo</tt> and <tt>example:lala</tt>, for use in modules.conf or with ?insmod.
 === Using a custom Makefile ===

@@ Line 88: / Line 88: @@
 '''A)''' The DLL project comes with some template files. Remove them by right clicking on their tab and selecting close.
-'''B)''' Click the icon of a document with a plus sign on it. This will open a dialog that lets you add files to the project. Here you can add the module's source files. For nomysql this is just nomysql.c. Also add util.c from from asss/src/main. You can download the ASSS source code from [http://sscx.net/asss sscx.net/asss].
+'''B)''' Click the icon of a document with a plus sign on it. This will open a dialog that lets you add files to the project. Here you can add the module's source files. For nomysql this is just nomysql.c. Also add util.c from from asss/src/main. You can download the ASSS source code from http://asss.yi.org/asss.
 <br><br>

@@ Line 141: / Line 141: @@
 [[Image:devcpp-140-step10.png|left]]
 If all goes well you should see this dialog. Congratulations on compiling your first module!
 === With MSVC ===

@@ Line 69: / Line 69: @@
 === With Dev C++ ===
--write me-
+This tutorial uses [http://www.bloodshed.net/dev/devcpp.html Dev C++ 4.9.9.2] ASSS 1.4.0 and Smong's [http://toktok.sscentral.com/ss-asss.html nomysql] module. Although it should work with all modules and a recent version of Dev C++.
 === With MSVC ===

@@ Line 86: / Line 86: @@
 $ grep 'cfg.Get' bin/module.py
 </pre>
-I suggest putting module settings in their own .conf file and include this from your arena.conf.
+I suggest putting module settings in their own .conf file and include this from your [[arena.conf]].
 There may also be commands that you must set the permissions for. You can add new commands to the group files found in conf/groupdef.dir. Prefix cmd_ to the command to allow users to send the command publicly and privcmd_ for team and private targets.