[Xtreme]

• • • 
      A "New" Life™
      (XAdmin's Only Ultimate Manual)
      
      _________________________________________________
      
      [size=14pt]The DETAILS of this Release
      
      Background Information: Well, the moment has come. This release is packed with crucial updates, along with a lot of other interesting ones. You will easily be amazed by all of the features that this release contains, which are going to be discussed later in the post. However, this is nothing like the other versions of Xtreme Administration.
      
      The New Features: Well, lets start simple. The new features are plentiful and will require a lot of describing. Here we go:
      
      • Level System: A simple configuration file and/or function in the script will allow you to set your own levels. Lets drift apart from the old 10 level administration system. Each command has its own pre-set level in the file. The default maximum level is 10. All you have to do is open that configuration file and change the levels you want. It's all that simple. Conclusively, you can have as many levels as you want; 1 or 1,000,000! The choice is yours.
        
      • Custom Configuration Explained- This by far is , in my opinion, the best feature, for it allows you to configure mostly every command individually in some matter. As like the level system, there is also a set configuration file set up for these commands. Once ingame, just type /UCONFIG to reupdate the variables. Here are the list of variables that you can edit:
        • ServerMessage- This stores the server message for when you connect.
        • Teleport_X_Offset - This is the offset for the X coordinate when you teleport or get teleported.
        • Teleport_Y_Offset - This is the offset for the Y coordinate when you teleport or get teleported.
        • Teleport_Z_Offset - This is the offset for the Z coordinate when you teleport or get teleported.
        • MinimumPasswordLength - The minimum password length for when you register.
        • DisplayServerMessage - Display the server message on connect?
        • SlapDecrement - The amount of health to take away when you slap someone.
        • WiredWarnings - The amount of warnings to address when you wire someone.
        • GodWeapons - Give weapons for /god?
        • MaxLevel - The maximum admin level.
        • DisplayCommandMessage - Display the admin used a command?
        • DisplayConnectMessages - Display connect and disconnect messages?
        • MaxPing - The maximum ping to allow for the ping kicker (0 = off).
        • AdminImmunity - Make admins immune for the ping kicker?
        • PingSecondUpdate - The amount of seconds to check everyone's ping.
        • ForbidData - Action to assign when a player joins with a forbidden name (0=nothing, 1=kick, 2=ban)
        • DisableJailCommands - Boolean to prevent users from using commands whilst jailed.
        • WireWithPM - Boolean to deliver wire actions when a player is wired and sends a PM.
        • ExposePMS - Boolean, when set, will send the PM, along with sender name/id and player name/id, to administrators.
      • Player Variables- The player variables are found in the third and final configuration file. These variables will register to every player's configuration file upon registering. NOTE: These have to be set in the script. There is a function called 'CreateUserConfigFile' which can be found under 'OnFilterscriptInit'. ADD variables to it, for all of the predefined ones are used in the entire script.
        
      • Registration System- First of all, the x prefix has been removed- just a note. There are new registration messages when you connect. The commands include:
        • /REGISTER- Use this command if it tells you to; you have not registered an account. Upon registering, you can put text in the 'OnPlayerRegister' callback if you need anything specific for your game mode. Also, you will automatically be logged in and your IP will report to the file.
        • /LOGIN- This command will only appear if the ip in your file is different than the one you are connecting to; otherwise you will auto-login. Once again, there is an OnPlayerLogin function.
        • /LOGOUT- Use this when you want to logout; but when you leave the server you will automatically log out! Additionally, there's an OnPlayerLogout function as well.
      • Ping Kick System- The ping kick is a unique system which will kick any players who exceed the maximum set ping. As described, you can set a configuration variable which will toggle admin immunity, and ingame you can use /SETPING for the same purpose.
        
      • Jail System- This system is primarily for jailing people permanently in their cells until unjailed. Upon the /XJAIL command, the player will be teleported to a jail cell, and on respawn they will be teleported back. Unjailing them respawns them correctly and out of jail.
        
      • Spectator System- Along with 0.2, a proper spectator system has been implemented. It works like a charm, and a feature you'll have to see for yourself. When a player enters and leaves a vehicle, you do not have to re-spectate them.
        
      • Wire System- It was described that the old wire system crashed the server with 0 warnings, additionally it prevented everyone from talking when trying to use the script with 0.2. With the new wire system, there are no server crashes, and like all the other systems, should work perfectly without hesitation.
        
      • Giveme System- Yes, with the creation of dynamic vehicles, included with XAdmin is an administrator giveme menu, which in terms, will create the vehicle which you select from the menu. Upon selection, you will be inserted into the vehicle at the angle you were standing. Pretty cool, huh? Additionally, if you give yourself a vehicle in an interior, it will link inside-- No more invisible cars!
        
      • Improved Goto and Gethere- Upon teleporting, you will be teleported to the interior of the player; however there are some 0.2 bugs upon teleporting, so if it doesn't teleport you right, DO IT AGAIN and it will work. The same applies for gethere. As described, you can set the offsets of the teleports by configuration variables. Once you have altered those, just type /UCONFIG ingame and presto; changed.
        
      • Admin CHAT SYSTEM- The default character for admin chat is now #<text>, since most modes do not use the pound symbol for team chats. The admin messages are ensured to be sent only to administrators online, and not to players.
        
      • NICK OR ID- You CAN use the nick portion (part of a name) of the command instead of the id. It is fixed to all it's entirety from v1.3. It's there for a reason after all.
      • Car Lock and Unlock- Another system implemented: You now have the ability to lock and unlock your vehicles. When you exit the vehicle, it will be unlocked so this way you don't have to unlock all vehicles or restart the mode.
      • Name Join System- Included in release- see Xadmin Guides folder.
        
      Some Important Updates- Well, this script is only compatible with SA:MP 0.2. The script has been completely redone, and has vastly improved from the old one. The script uses DCMD for maximum processor efficiency. Additionally, not in this release, but in the final release of v2.0 (since this is only a pre-release), you will be able to take advantage of the custom functions, like 'IsPlayerXAdmin', 'GetPlayerFileVar', 'GetPlayerFile', 'IsPlayerLevel', etc in your filterscripts and gamemodes. Unlike the old version, the efficiency itself has improved, and contains maximum customization features so you won't have to go edit the script. Now, for the fun stuff. There are menus in certain systems, such as /giveme, /weather, and /givecar implemented for you to have maximized organization technique in operating your server. Before this derives your focus, since there are dynamic filterscripts, if you load or reload the filterscript, you will be re-connected just like when you connect to the server. Finally, the connect and disconnect messages are the same colour as Connecting to xx.xx.xxx.xxx... message, just like 0.1b!
      _________________________________________________
      
      The COMMANDS
      Here are the commands with their basic functions:
      
      Administration Commands: This is the list of administration commands included with the release:
      • #<TEXT> - Admin chat
      • /XCOMMANDS - Ingame commands list.
      • /GOTO <NICK OR ID> - Teleports you to a player in a car or on foot.
      • /GETHERE <NICK OR ID> - Teleports a player to you in a car or not.
      • /MORNING, /NOON, /EVENING, /MIDNIGHT- Set the world time.
      • /SETTIME <NICK | ID> <HOUR> <MINUTE> - Set the time of that player.
      • /ANNOUNCE <TEXT> - Send game text to all players.
      • /SAY <TEXT> - Send a client message with your text.
      • /FLIP - Flip your vehicle onto its wheels.
      • * Xtreme slaps <NICK | ID> - Decrement a player's health by the amount set in config. around a bit with a large trout.
      • /WIRE <NICK | ID> - Prevent a player from talking; issues warnings.
      • /UNWIRE <NICK | ID> - Allow a player to talk again.
      • /KICK <NICK | ID> (<REASON>) - Kick a player from the server with an optional reason.
      • /BAN <NICK | ID> (<REASON>) - Ban a player with an optional reason.
      • /AKILL <NICK | ID> - Automatically kill a player.
      • /EJECT <NICK | ID> - Eject a player from their vehicle.
      • /FREEZE and /UNFREEZE <NICK | ID> - Freeze or unfreeze a player.
      • /OUTSIDE - Transfers everyone outside.
      • /HEALALL - Sets everyone's health to 100.
      • /UCONFIG - Update the configuration variables for use in the server.
      • /SETSM <MESSAGE> - Set the server message whilst ingame.
      • /GIVEHEALTH <NICK | ID> <1-100> - Add to a player's health.
      • /SETHEALTH <NICK | ID> <1-100> - Set a player's health.
      • /SKINALL <SKINID> - Sets everyone's skin to a valid skin id.
      • /GIVEALLWEAPON <WEAPON NAME | ID> <1-10,000> - Give everyone a weapon with the specified ammunition.
      • /RESETALLWEAPONS - Reset every player's weapons.
      • /SETCASH /GIVECASH /REMCASH <NICK | ID> <1-1,000,000> - Set, add to, or remove the specified amount of cash from a player's wallet correspondingly.
      • /RESETCASH <NICK | ID> - Reset a player's cash.
      • /SETALLCASH /GIVEALLCASH /REMALLCASH <1-1,000,000> - Set, add to, or remove an amount of cash from every player's wallet.
      • /RESETALLCASH - Reset all player's cash.
      • /EJECTALL - Eject every player who is in a vehicle on any seat.
      • /FREEZEALL /UNFREEZEALL - Freeze or unfreeze every player in the server.
      • /GIVEWEAPON <NICK | ID> <WEAPON NAME | ID> <1-10,000> - Give a player a specific weapon with the specified ammunition.
      • /GOD - Give yourself infinite health, and if specified in configuration, infinite minigun and grenades.
      • /RESETSCORES <NICK | ID> - Reset the scores of a specific player.
      • /SETLEVEL <NICK | ID> <0 - MAXLEVEL> - Set a player's level from 0 to the maximum level defined in the configuration file, where 0 is member.
      • /SETSKIN <NICK | ID> <SKINID> - Set a player's skin to a valid skin id.
      • /GIVEARMOUR <NICK | ID> <1-100> - Add the value specified to a player's armour.
      • /SETARMOUR <NICK | ID> <1-100> - Set a player's armour.
      • /ARMOURALL - Give every player in the server 100 armour.
      • /SETAMMO <NICK | ID> <WEAPONSLOT> <1-10,000> - Set a player's weapon ammo in that slot to the specified amount.
      • /SETSCORE <NICK | ID> <SCORE> - Set a player's score.
      • /IP (<NICK | ID>) - Display yours or another player's ip.
      • /PING (<NICK | ID>) - Display yours or another player's ping.
      • /EXPLODE <NICK | ID> - Explode a player in or out of a vehicle; kill them instantly.
      • /SETALLTIME <HOUR> <MINUTE> - Set everyone's time to the specified hour and minute.
      • /FORCE <NICK | ID> - Instantly make the player return to the spawn selection scren.
      • /SETALLWORLD <0-255> - Set everyone's virtual world to the specified id.
      • /SETWORLD <NICK | ID> <0-255> - Set a player's virtual world to the specified id.
      • /SETGRAVITY <-50 - 50> - Set the server gravity to the specified float value.
      • /SETWANTED <NICK | ID> <0-6> - Set a player's wanted level.
      • /SETALLWANTED <0-6> - Set all player's wanted level.
      • /XLOCK /XUNLOCK - Lock or unlock your vehicle.
      • /GMX - Restart the game mode.
      • /CARHEALTH <NICK | ID> <0 - 1000> - Set a player's car's health.
      • /WEATHER - Bring up a menu with various weather types to set.
      • /SETPING <0 - 10,000 | OFF> - Set the max ping to the value specified (0 and off are the same).
      • /GIVEME - Bring up a menu with various cars to spawn you in to drive.
      • /GIVECAR - Bring up a menu with various car components to add to your vehicle (won't work on bikes ).
      • /SPEC <NICK | ID | OFF> - Spectate a player, or turn the spectator off.
      • /XJAIL /XUNJAIL <NICK | ID> - Jail or unjail a player.
      • /SETNAME <NICK | ID> <NAME> - Change a player's name.
      • /VR - Defaultly a player command, repairs your vehicle's health.
      Player Commands: Although there are not as many player commands as before, surely enough there are some. The player commands include:
      • /ADMINS- Display a list of administrators with the level.
      • /REGISTER, /LOGIN, /LOGOUT
      • /XINFO- Display the script information.
      • /SM - Display the server message.
      Some Notes: Some commands you can use on yourself and others you can't. Additionally, some commands have specific restrictions, for example: a player must be in a vehicle to eject them.
      _________________________________________________
      
      Altering the PHYSICAL aspects of the Xtreme Administration Filterscript
      Information: If you are inclined to add features to your version, lets just start off by saying that mostly everything defaultly set, except the levels, should not be altered, but it is best for you if you only add new features. There are two methods upon editing the variables:
      
      • File-Wise- With this method, you will not be able to add any new commands, however you will easily be able to change variables such as configuration. Changing the variables in the 'Variables.ini' file will not be affected; you'll have to edit them in the script. However, the Configuration.ini and Commands.ini can be changed respectively. As mentioned, if you change the Configuration.ini variables, you'll either have to reload the filterscript or type /UCONFIG ingame.
      • Script-Wise- With this method, you can add new things if you know what you are doing. The system was meant to be easy for this purpose. Well, lets get started. You will notice under OnFilterScriptInit() that there are many comments which will explain what to do.
        
      The function 'CreateLevelConfig' is the first thing to edit. Although the name might be misleading, that is actually the variables which are created when the player registers to the server. Do not edit the existing ones unless you want to change everything in the script. The pattern is "variable","variable",... Pretty self explanatory. In the final release, you will be able to use the variables more easily because the functions will be includes.
      
      The next thing to edit, 'CreateCommandConfigEx' is there because it will not recreate the configuration file, at least with those commands. The pattern is "command",level,"command",level... If you change any command names, you'll have to edit a lot in the command itself. If you edit 'CreateCommandConfig', the changes will not be editable when the filterscript restarts.
      
      How to edit forbidden name configuration is included in the Xadmin guides.
      _________________________________________________
      
      Common Problems Upon Usage
      There are not a lot of common problems at this time discovered, the only problem that you might encounter is with the jail. If you kill yourself and respawn in the jail, but fall through the floor, make sure you don't have 'SetPlayerInterior(playerid,0);' under your OnPlayerSpawn callback.
      
      If you have problems with setting your level as 10, joining the server, doing a command and it returns an error, make sure you are logged in and your level is at least that command's level. If all fails, make sure to restart your game and if that fails, type reloadfs XtremeAdmin2 whilst ingame.
      
      Additionally, if you encounter a problem with /SETNAME, please make sure you have SA:MP Scripting Pack Release RC2 or greater.
      
      _________________________________________________
      
      Using the Xtreme Administration Filterscript
      _________________________________________________
      
      DOWNLOAD the Xtreme Administration Filterscript
      Found below is the download link for the Xtreme Administration filterscript PRE-RELEASE. All of the information, including how to use the script is all described above. For any additional questions, please leave a post here or Private Message me.
      
      [u]NEWEST Version: 2.2 (REL: 1)
      Description: Features added into this version include:
      • IP Join leak fix.
      • Ability to set skins using the new system.
      • The ability to see people's pms based on a configuration variable (set ExposePMS to 1).
      • The ability to wire people on a PM (set WireWithPM to 1).
      Download Source, Compiled Version, and Required Libraries All in One: via GTAGaming - Click Me
      
      
      ○•PEACE, Xtreme of SA:MP•○