Modules Introduction: Difference between revisions
m (Updated tutorial) |
mNo edit summary |
||
| 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=== | ||
Latest revision as of 17:06, 23 May 2023
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 started
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 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 of the sample module and download it (Green button "Code" -> "Download ZIP") then unpack the archive
Template's content
The structure of the template module
- hpp
- config.hpp
- functions.hpp
- main.hpp
- include
- lua
- lauxlib.h
- lua.h
- lua.hpp
- luaconf.h
- lualib.h
- mta
- CLuaArgument.hpp
- CLuaArguments.hpp
- ILuaModuleManager.hpp
- init.hpp
- mta_main.hpp
- lua
- lib
- lua5.1.lib
- lua5.1_64.lib
- src
- mta
- CLuaArgument.cpp
- CLuaArguments.cpp
- mta_main.cpp
- functions.cpp
- main.cpp
- mta
- ml_basic.sln
- ml_basic.vcxproj
- ml_basic.vcxproj.filters
- ml_basic.vcxproj.user
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