Modules Introduction - Revision history

Allerek: links edited to match official repo

2026-03-20T13:30:25Z

links edited to match official repo

← Older revision		Revision as of 13:30, 20 March 2026
Line 13:		Line 13:
	Open the command prompt (Win + R -> CMD) and enter this command:		Open the command prompt (Win + R -> CMD) and enter this command:
	<pre<includeonly/>>		<pre<includeonly/>>
	<span style="color:yellow">git</span> clone https://github.com/~~TracerDS~~/mtasa-modules.git		<span style="color:yellow">git</span> clone https://github.com/multitheftauto/mtasa-modules.git
	</pre>		</pre>

	===From website===		===From website===
	Go to the website [https://github.com/~~TracerDS~~/mtasa-modules of the sample module] and download it (Green button "Code" -> "Download ZIP") then unpack the archive		Go to the website [https://github.com/multitheftauto/mtasa-modules of the sample module] and download it (Green button "Code" -> "Download ZIP") then unpack the archive

	<!--		<!--

FileEX at 18:05, 17 March 2025

2025-03-17T18:05:09Z

← Older revision		Revision as of 18:05, 17 March 2025
Line 1:		Line 1:
			{{Warning\|This is an unofficial article and the github link may not work}}

	Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as [[Modules/Sockets\|sockets]].		Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as [[Modules/Sockets\|sockets]].

Tracer at 17:06, 23 May 2023

2023-05-23T17:06:00Z

← Older revision		Revision as of 17:06, 23 May 2023
Line 17:		Line 17:
	Go to the website [https://github.com/TracerDS/mtasa-modules of the sample module] and download it (Green button "Code" -> "Download ZIP") then unpack the archive		Go to the website [https://github.com/TracerDS/mtasa-modules of the sample module] and download it (Green button "Code" -> "Download ZIP") then unpack the archive

			<!--
	== How do I start? ==		== How do I start? ==
	Go to the <pre>./mtasa-modules/ml_example</pre> folder		Go to the <pre>./mtasa-modules/ml_example</pre> folder
Line 29:		Line 30:
	After running the script, a new folder should be created called '''myModule_module'''.		After running the script, a new folder should be created called '''myModule_module'''.
	A Visual Studio project and a README file that you <span style="color:red">'''MUST read'''</span> will be created in the current folder.		A Visual Studio project and a README file that you <span style="color:red">'''MUST read'''</span> will be created in the current folder.
			-->
	==Template's content==		==Template's content==
	===The structure of the template module===		===The structure of the template module===

Tracer: Updated tutorial

2023-05-23T17:04:41Z

Updated tutorial

← Older revision		Revision as of 17:04, 23 May 2023
Line 31:		Line 31:

	==Template's content==		==Template's content==
	~~<ul><h3>~~The structure of the template module~~</h3>~~		===The structure of the template module===
	~~<li>~~<span style="color:#177eff">'''~~include~~'''</span></li><ul>		*<span style="color:#177eff">'''hpp'''</span>
	<~~!---~~-><li><span style="color:#177eff;background-color:#880000">'''~~init~~'''</span~~><ul~~>		**<span style="color:#16c80c">config.hpp</span>
	<~~!-----~~-><li><span style="color:#16c80c;background-color:#880000">~~Common~~.h</span~~></li~~>		**<span style="color:#16c80c">functions.hpp</span>
	~~<!------><li>~~<span style="color:#16c80c;background-color:#880000">~~ILuaModuleManager~~.h</span~~></li~~>		**<span style="color:#16c80c;background-color:#880000">main.hpp</span>
	~~<!------><li>~~<span style="color:#16c80c;background-color:#880000">~~lauxlib~~.h</span~~></li~~>		*<span style="color:#177eff;background-color:#880000">'''include'''</span>
	~~<!------><li>~~<span style="color:#16c80c;background-color:#880000">luaconf.h</span~~></li~~>		**<span style="color:#177eff;background-color:#880000">'''lua'''</span>
	~~<!------><li>~~<span style="color:#16c80c;background-color:#880000">~~lua~~.h</span~~></li~~>		***<span style="color:#16c80c;background-color:#880000">lauxlib.h</span>
	~~<!------><li>~~<span style="color:#~~16c80c~~;background-color:#880000">~~lua.hpp~~</span~~></li~~>		***<span style="color:#16c80c;background-color:#880000">lua.h</span>
	~~<!------><li>~~<span style="color:#16c80c;background-color:#880000">~~lualib~~.h</span~~></li>~~		***<span style="color:#16c80c;background-color:#880000">lua.hpp</span>
	~~<!----></ul></li~~>		***<span style="color:#16c80c;background-color:#880000">luaconf.h</span>
	~~<!----><li>~~<span style="color:#16c80c">~~CFunctions~~.h</span~~></li~~>		***<span style="color:#16c80c;background-color:#880000">lualib.h</span>
	~~<!----><li>~~<span style="color:#16c80c;background-color:#880000">~~CLuaArgument~~.h</span~~></li~~>		**<span style="color:#177eff;background-color:#880000">'''mta'''</span>
	~~<!----><li>~~<span style="color:#16c80c;background-color:#880000">~~CLuaArguments~~.h</span~~></li~~>		***<span style="color:#16c80c;background-color:#880000">CLuaArgument.hpp</span>
	~~<!----><li>~~<span style="color:#16c80c">~~ml_moduleName~~.hpp</span~~></li></ul~~>		***<span style="color:#16c80c;background-color:#880000">CLuaArguments.hpp</span>
	~~<li>~~<span style="color:#177eff;background-color:#880000">'''lib'''</span~~><ul~~>		***<span style="color:#16c80c;background-color:#880000">ILuaModuleManager.hpp</span>
	~~<!----><li>~~<span style="color:#16c80c;background-color:#880000">lua5.1.lib</span~~></li~~>		***<span style="color:#16c80c;background-color:#880000">init.hpp</span>
	~~<!----><li>~~<span style="color:#16c80c;background-color:#880000">lua5.1_64.lib</span~~></li></ul~~>		***<span style="color:#16c80c;background-color:#880000">mta_main.hpp</span>
	~~<li>~~<span style="color:#177eff">'''src'''</span~~></li><ul~~>		*<span style="color:#177eff;background-color:#880000">'''lib'''</span>
	<~~!---~~-><li><span style="color:#16c80c">~~CFunctions~~.cpp</span~~></li~~>		**<span style="color:#16c80c;background-color:#880000">'''lua5.1.lib'''</span>
	~~<!----><li>~~<span style="color:#16c80c;background-color:#880000">~~CLuaArgument~~.cpp</span~~></li~~>		**<span style="color:#16c80c;background-color:#880000">'''lua5.1_64.lib'''</span>
	~~<!----><li>~~<span style="color:#16c80c;background-color:#880000">~~CLuaArguments~~.cpp</span~~></li~~>		*<span style="color:#177eff">'''src'''</span>
	~~<!----><li>~~<span style="color:#16c80c">~~ml_example~~.cpp</span~~></li></ul~~>		**<span style="color:#177eff;background-color:#880000">'''mta'''</span>
	~~<li>~~<span style="color:#16c80c">~~ml_moduleName~~.~~sln~~</span~~></li~~>		***<span style="color:#16c80c;background-color:#880000">CLuaArgument.cpp</span>
	~~<li>~~<span style="color:#16c80c">~~ml_moduleName~~.~~vcxproj~~</span~~></li~~>		***<span style="color:#16c80c;background-color:#880000">CLuaArguments.cpp</span>
	~~<li>~~<span style="color:#16c80c">~~ml_moduleName~~.vcxproj~~.filters~~</span~~></li~~>		***<span style="color:#16c80c;background-color:#880000">mta_main.cpp</span>
	~~<li>~~<span style="color:#16c80c">~~ml_moduleName~~.vcxproj.~~user~~</span~~></li~~>		**<span style="color:#16c80c">functions.cpp</span>
	~~<li>~~<span style="color:#16c80c">~~README~~</span~~></li~~>		**<span style="color:#16c80c">main.cpp</span>
	~~</ul>~~		*<span style="color:#16c80c">ml_basic.sln</span>
			*<span style="color:#16c80c">ml_basic.vcxproj</span>
			*<span style="color:#16c80c">ml_basic.vcxproj.filters</span>
			*<span style="color:#16c80c">ml_basic.vcxproj.user</span>

	<hr/>		<hr/>

	Files are marked in <span style="color:#16c80c">green font</span><br/>		Files are marked in <span style="color:#16c80c">green font</span><br/>
	Folders are marked in <span style="color:#177eff">'''bolded blue font'''</span><br/>		Folders are marked in <span style="color:#177eff">'''bolded blue font'''</span><br/>
	<span style="color:#16c80c;background-color:#880000">Files</span> and <span style="color:#177eff;background-color:#880000">'''folders'''</span> that '''should not''' be modified are marked in <span style="background-color:#880000">red</span>		<span style="color:#16c80c;background-color:#880000">Files</span> and <span style="color:#177eff;background-color:#880000">'''folders'''</span>
			that '''should not''' be modified are marked in <span style="background-color:#880000">red</span>
	~~==What is ___?==~~
	~~'''Q:''' Folder '''init'''?<br/>~~
	~~'''A:''' Dont touch this folder. The headers needed for initial module initialization are stored there.~~

	~~'''Q:''' File '''CFunctions.h'''?<br/>~~
	~~'''A:''' The declarations of user-created functions are stored there.~~
	~~The definitions of these functions are stored in the file '''CFunctions.cpp'''.~~

	~~'''Q:''' Folder '''lib'''?<br/>~~
	~~'''A:''' Do not touch it at all. It stores the libraries needed for the connection between C++ and Lua.~~

	~~'''Q:''' Files '''CLuaArgument/s.h/.cpp'''?<br/>~~
	~~'''A:''' These files are used to correctly handle parameters from C++ to Lua~~

	<!--		<!--

Tracer: Fixed a typo

2022-12-24T13:18:52Z

Fixed a typo

← Older revision		Revision as of 13:18, 24 December 2022
Line 1:		Line 1:
	Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as [[Modules/Sockets\|sockets]].		Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as [[Modules/Sockets\|sockets]].

	==Getting ~~sterted~~==		==Getting started==
	To start writing new modules, you need to have at least basic knowledge of programming in C/C++.<br/>		To start writing new modules, you need to have at least basic knowledge of programming in C/C++.<br/>
	This tutorial '''does not teach''' you how to get started with C++. <br/>		This tutorial '''does not teach''' you how to get started with C++. <br/>

Tracer: Added polish reference

2022-06-07T07:27:04Z

Added polish reference

← Older revision		Revision as of 07:27, 7 June 2022
Line 83:		Line 83:
	<span style="font-weight:bold;font-size:large">[[Modules_Introduction_2\|Part 2]]</span>		<span style="font-weight:bold;font-size:large">[[Modules_Introduction_2\|Part 2]]</span>
	-->		-->

			[[pl:Modules Introduction]]

Tracer: Changed formatting

2022-06-07T07:24:47Z

Changed formatting

← Older revision		Revision as of 07:24, 7 June 2022
Line 63:		Line 63:

	Files are marked in <span style="color:#16c80c">green font</span><br/>		Files are marked in <span style="color:#16c80c">green font</span><br/>
	Folders are marked in <span style="color:#177eff">bolded blue font</span><br/>		Folders are marked in <span style="color:#177eff">'''bolded blue font'''</span><br/>
	<span style="color:#16c80c;background-color:#880000">Files</span> and <span style="color:# 177eff;background-color:#880000">folders</span> that '''should not''' be modified are marked in <span style="background-color:#880000">red</span>		<span style="color:#16c80c;background-color:#880000">Files</span> and <span style="color:#177eff;background-color:#880000">'''folders'''</span> that '''should not''' be modified are marked in <span style="background-color:#880000">red</span>

	==What is ___?==		==What is ___?==

Tracer: Changed formatting

2022-06-07T07:23:28Z

Changed formatting

← Older revision		Revision as of 07:23, 7 June 2022
Line 10:		Line 10:
	Make sure you have the [https://git-scm.com/downloads GIT] source control package installed.		Make sure you have the [https://git-scm.com/downloads GIT] source control package installed.
	Open the command prompt (Win + R -> CMD) and enter this command:		Open the command prompt (Win + R -> CMD) and enter this command:
	<~~p style="background-color:#141821;color:#fff;font-family:Consolas,Monaco,Lucida Console,Liberation Mono,DejaVu Sans Mono,Bitstream Vera Sans Mono,Courier New, monospace;padding:1%"~~>		<pre<includeonly/>>
	<span style = "color: yellow"> git </span> clone https://github.com/TracerDS/mtasa-modules.git		<span style="color:yellow">git</span> clone https://github.com/TracerDS/mtasa-modules.git
	</p>		</pre>

	===From website===		===From website===
Line 28:		Line 28:

	After running the script, a new folder should be created called '''myModule_module'''.		After running the script, a new folder should be created called '''myModule_module'''.
	A Visual Studio project and a README file that you <span style = "color: red">'''MUST read'''</span> will be created in the current folder.		A Visual Studio project and a README file that you <span style="color:red">'''MUST read'''</span> will be created in the current folder.

	==Template's content==		==Template's content==

Tracer: Created page with "Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as sockets. ==Getting sterted== To start writing new modules, you need to have at least basic knowledge of programming in C/C++.
This tutorial '''does not teach''' you how t..."

2022-06-07T06:14:52Z

Created page with "Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as sockets. ==Getting sterted== To start writing new modules, you need to have at least basic knowledge of programming in C/C++. This tutorial '''does not teach''' you how t..."

New page

Modules are extensions for Multi Theft Auto's Lua core, allowing the integration and use of custom Lua functions that have been written in C++, and compiled as a DLL or SO file. Modules are commonly used to create functions for such purposes that Multi Theft Auto lacks, such as [[Modules/Sockets|sockets]].

==Getting sterted==
To start writing new modules, you need to have at least basic knowledge of programming in C/C++. 
This tutorial '''does not teach''' you how to get started with C++. 
Let's start by downloading a template to create our own module.
We can do it in 2 ways:

===From terminal===
Make sure you have the [https://git-scm.com/downloads GIT] source control package installed.
Open the command prompt (Win + R -> CMD) and enter this command:

 git clone https://github.com/TracerDS/mtasa-modules.git


===From website===
Go to the website [https://github.com/TracerDS/mtasa-modules of the sample module] and download it (Green button "Code" -> "Download ZIP") then unpack the archive

== How do I start? ==
Go to the <pre>./mtasa-modules/ml_example</pre> folder

===Windows===
Open CMD in that folder and then run the '''newModule.bat''' script in this form: <code>.\newModule.bat moduleName</code> e.g. <code>.\newModule.bat myModule</code>

===Linux===
Open terminal in that folder and then run the '''newModule.sh''' script in this form: <code>./newModule.sh moduleName</code> e.g. <code>./newModule.sh myModule</code>

After running the script, a new folder should be created called '''myModule_module'''.
A Visual Studio project and a README file that you '''MUST read''' will be created in the current folder.

==Template's content==
<ul><h3>The structure of the template module</h3>
<li>'''include'''</li><ul>
<li>'''init'''<ul>
<li>Common.h</li>
<li>ILuaModuleManager.h</li>
<li>lauxlib.h</li>
<li>luaconf.h</li>
<li>lua.h</li>
<li>lua.hpp</li>
<li>lualib.h</li>
</ul></li>
<li>CFunctions.h</li>
<li>CLuaArgument.h</li>
<li>CLuaArguments.h</li>
<li>ml_moduleName.hpp</li></ul>
<li>'''lib'''<ul>
<li>lua5.1.lib</li>
<li>lua5.1_64.lib</li></ul>
<li>'''src'''</li><ul>
<li>CFunctions.cpp</li>
<li>CLuaArgument.cpp</li>
<li>CLuaArguments.cpp</li>
<li>ml_example.cpp</li></ul>
<li>ml_moduleName.sln</li>
<li>ml_moduleName.vcxproj</li>
<li>ml_moduleName.vcxproj.filters</li>
<li>ml_moduleName.vcxproj.user</li>
<li>README</li>
</ul>
<hr/>

Files are marked in green font 
Folders are marked in bolded blue font 
Files and folders that '''should not''' be modified are marked in red

==What is ___?==
'''Q:''' Folder '''init'''? 
'''A:''' Dont touch this folder. The headers needed for initial module initialization are stored there.

'''Q:''' File '''CFunctions.h'''? 
'''A:''' The declarations of user-created functions are stored there.
The definitions of these functions are stored in the file '''CFunctions.cpp'''.

'''Q:''' Folder '''lib'''? 
'''A:''' Do not touch it at all. It stores the libraries needed for the connection between C++ and Lua.

'''Q:''' Files '''CLuaArgument/s.h/.cpp'''? 
'''A:''' These files are used to correctly handle parameters from C++ to Lua