Merge pull request #98 from NexiusTailer/develop

Lots of fixes and improvements

Author: colistro123

.github/ISSUE_TEMPLATE/function_request.md

@@ -18,4 +18,4 @@ labels: function
 <!-- If you know equivalent of the function or functions in MTA, please write it here. -->
 
 **Additional information**
-<!-- The additional information can be an article about it, wiki of SAMP or something that can helps us. -->
+<!-- The additional information can be an article about it, wiki of SA-MP or something that can helps us. -->

README.md

@@ -4,7 +4,7 @@
 
 *amx* is a software package that allows the execution of unmodified San
 Andreas: Multiplayer 0.3.7 gamemodes, filterscripts and plugins on Multi
-Theft Auto: San Andreas 1.5.8 and higher servers. It is open source, and [**a prebuilt
+Theft Auto: San Andreas 1.6 and higher servers. It is open source, and [**a prebuilt
 binary for Windows is available for testing purposes right now**](https://github.com/multitheftauto/amx/releases).
 
 - [License](#license)
@@ -86,12 +86,19 @@ features:
 ## Installation
 
 *amx* consists of a binary server module (.dll/.so) and a Lua resource.
-It will only run on MTA:SA 1.0 and later. Installation steps are lined
+It will only run on MTA:SA 1.6 and later. Installation steps are lined
 out below.
 
 ### Extracting
 
-Extract the "mods" folder into your MTA "server" directory.
+- All needed binary files are in the archive provided on Releases
+  page. Unpack amx.zip and extract the `mods` folder into your MTA
+  `server` directory.
+
+- `amx` folder located in mods/deathmatch/resources is a place for the
+  mentioned Lua resources. It will be empty at this point, so you need
+  to copy all the latest files of `amx` folder from this repository
+  into your `amx` folder.
 
 ### Configuration
 
@@ -125,13 +132,16 @@ Extract the "mods" folder into your MTA "server" directory.
 
   The following rights are used for the following purposes:
 
-  - `general.ModifyOtherObjects`: to access files of `amx-*`
-    resources
+  - `general.ModifyOtherObjects`:
+      - to access files of `amx-*` resources
   - `function.startResource`  \
     `function.stopResource`  \
     `function.restartResource`:
       - to automatically (re)start filterscripts when `amx` starts
       - for rcon
+  - `function.getServerPassword`  \
+    `function.setServerPassword`:
+      - for rcon
 
 ### Migrating gamemodes, filterscripts, plugins from an SA-MP server
 
@@ -179,7 +189,7 @@ Information about this is lined out below.
 
 - In SA-MP, there is one folder that contains all gamemodes and
   another that contains all filterscripts. In MTA, it is the
-  convention to create a separate resource (i.e. folder) for each
+  convention to create a separate resource (i.e. folder) for each
   gamemode. *amx* follows the MTA convention for better integration,
   which means that a resource needs to be created for each gamemode
   and filterscript. The naming convention for these is amx-*name* for
@@ -250,7 +260,7 @@ Information about this is lined out below.
 
 ## Running gamemodes and filterscripts
 
-Before you can run sa-mp modes or filterscripts, you need to start the
+Before you can run SA-MP modes or filterscripts, you need to start the
 *amx* resource. Type this command in the server console or as admin in
 the ingame console:
 
@@ -378,7 +388,7 @@ amxRegisterPawnPrototypes(prototypes);
 native amxVersion ( &Float:ver );
 ```
 
-Retrieves the *amx* version as a floating point number, e.g. `1.3`.
+Retrieves the *amx* version as a floating point number, e.g. `1.3`.
 
 ### amxVersionString
 
@@ -523,7 +533,7 @@ with [amxRegisterLuaPrototypes](#amxRegisterLuaPrototypes). Both
 functions associate a number of function names with their argument types
 and (optionally) return type. To specify a return type, prepend the
 function name with the type letter followed by a colon (:), for example:
-`f:testfn`. If you do not specify a return type (i.e. only specify the
+`f:testfn`. If you do not specify a return type (i.e. only specify the
 name, `testfn`), "i" will be assumed.
 
 See the syntax sections of the two registration functions for the
@@ -666,16 +676,11 @@ is perfect. Below is a list of limitations that may or may not be
 addressed in later versions of *amx* and Multi Theft Auto.
 
 - The following scripting functions are currently not implemented and
-  will have no effect when called: AllowAdminTeleport,
-  AllowInteriorWeapons, AllowPlayerTeleport,
-  DisableInteriorEnterExits, EnableStuntBonusForAll,
-  EnableStuntBonusForPlayer, EnableTirePopping (tire popping is always
-  on), EnableZoneNames, LimitGlobalChatRadius, PlayerPlaySound,
-  SendDeathMessage (use the "killmessages" resource on your server
-  instead for graphical death messages), SetDeathDropAmount,
-  SetDisabledWeapons, SetEchoDestination, SetNameTagDrawDistance,
-  SetPlayerDisabledWeapons, SetTeamCount, SetVehicleNumberPlate,
-  ShowPlayerNameTagForPlayer, TextDrawSetProportional,
+  will have no effect when called: DisableInteriorEnterExits,
+  EnableStuntBonusForAll, EnableStuntBonusForPlayer, EnableTirePopping
+  (tire popping is always on), PlayerPlaySound, SendDeathMessage (use
+  the "killmessages" resource on your server instead for graphical
+  death messages), SetNameTagDrawDistance, TextDrawSetProportional,
   UsePlayerPedAnims.
 
 ## Credits

amx-deps/a_amx.inc

@@ -231,7 +231,7 @@ sub copySelection {
 
 print "> Configuring\n";
 
-# Read sa-mp config
+# Read SA-MP config
 my %sampcfg;
 open SAMPCFG, $oldsrvpath . "/server.cfg";
 while(<SAMPCFG>) {
@@ -279,7 +279,7 @@ sub copySelection {
 
 	# Get filterscripts already in amx meta.xml
 	my %usedFilterscripts = %{{ map {$_ => 1 if(!/^$/)} split(/\s+/, $filterscriptsNode->att("value")) }};
-	# Add filterscripts that are in samp's server.cfg and also exist in MTA
+	# Add filterscripts that are in SA-MP's server.cfg and also exist in MTA
 	if($sampcfg{filterscripts}) {
 		for(split /\s+/, $sampcfg{filterscripts}) {
 			next if(!-e $newsrvpath . "/mods/deathmatch/resources/amx-fs-$_");
@@ -289,7 +289,7 @@ sub copySelection {
 
 	# Get plugins already in amx meta.xml
 	my %usedPlugins = %{{ map {$_ => 1 if(!/^$/)} split(/\s+/, $pluginsNode->att("value")) }};
-	# Add plugins that are in samp's server.cfg and also exist in MTA
+	# Add plugins that are in SA-MP's server.cfg and also exist in MTA
 	if($sampcfg{plugins}) {
 		for(split /\s+/, $sampcfg{plugins}) {
 			next if(!-e $newsrvpath . "/mods/deathmatch/resources/amx/plugins/$_.dll" && !-e $newsrvpath . "/mods/deathmatch/resources/amx/plugins/$_.so");

amx-deps/amxdeploy.pl

@@ -1,5 +1,4 @@
 <meta>
   <info name="Advanced Map Xtreme" author="arc_" type="gamemode" />
   <!-- This is only a dummy file to prevent server errors. -->
-  <!-- See install.html for installation instructions -->
 </meta>

amx-deps/meta.xml

@@ -176,7 +176,7 @@ int CFunctions::amxLoad(lua_State *luaVM) {
 		return 1;
 	}
 
-	// Register sa-mp and plugin natives
+	// Register SA-MP and plugin natives
 	amx_CoreInit(amx);
 	amx_ConsoleInit(amx);
 	amx_FloatInit(amx);