====================================================
         Admin script guide
----------------------------------------------------

----------------------------------------------------
         Intro:
----------------------------------------------------

Ok now with the latest events that have happened over the last few days after I released 
Seph's Admin script, it has come to my attention that the script is FAR to complex
for the average JA user. So I have decided to create this guide to give you a step by step
instruction manual so you can get the most out of your admin script.

----------------------------------------------------
         Prologue:
----------------------------------------------------

Before I start there are a few things that we need to address.

-This script is NOT just for admins, any normal user is free to use this script and its
features.

-To use this script you must be playing JA. This script cannot be used outside of JA

-To edit the files you must open them with any text editor. For example Notepad, Wordpad etc.

-There are a number of ways to open this script for editing. Here are the main 2 ways:
	1. Double click the Admin.cfg file and seleft "open with"
	
	2. Right click the file, select proerties, the click the open with button.
	   Find and select the notepad or any text editor program. From then on you can
	   simply double click the script to open it and edit it with the selected program.

-Instructions on how to edit parts of the file are documented just above them.

----------------------------------------------------
	 Guide:
----------------------------------------------------

In this guide I will be showing you how to edit parts of this script to your likeing. Starting
with the first section: the Login inside the Admin.cfg file.

--------------Admin.cfg--------------

==========
The Login.
==========
CODE:
  say_team_mod "clan"
  clanpass ""
  amlogin ""


description:
	This section will automaticly do some of the clan stuff needed for JA
	"say_team_mod "Clan"" This is so that you can chat in clan chat.
	"clanpass " This is to login into clanchat, it is also used in tag protection.
	"amlogin " Admins use this to login to admin, the password entered determins what level of admin is granted.

	To edit this simply place the passwords in between the ". The say team mod is not required to be edited.

	Example-
		Clanpass "woopwoop"
		amlogin ""

		Here the person has logged into clanchat, but is not an admin.

=========
Admin commands.
=========
CODE:
	bind PGUP "vstr ADMIN_CMD_NEXT"	
	bind PGDN "vstr ADMIN_CMD_PREV"	
	bind HOME "vstr ADMIN_CMD_SWITH"
	bind END "vstr ADMIN_CMD_EXE"

Description:
	Well this section is for admins, however its rarely used. Feel free to completely remove
	or edit it.

	bind PGUP..... Used to cycle through availible commands. 
	bind PGDN.....  "ditto"
	bind HOME..... This button switches modes.
	bind END...... This is used to execute the desired command.

Edit how-to
	All that is needed is to change the word after "bind", currently PGUP and PGDN is the "page up" and "page down" keys,
	the other two are obvious. You can just select all and remove it completely if you do not want this keys used at all.

=========
Emote shortcuts keys.
=========
CODE:
	bind F11 "vstr prv_freeze"
	bind F12 "vstr nxt_freeze"
	bind F10 "vstr set_freeze"

Description:
	This here is a quick shortcut to change emotes without cycleing through the main script modes to find it.

	bind F11......cycle back through emotes
	bind F12......cycle forward through emotes
	bind F10......execute emote

Edit how-to
	Same as the admin commands, just change the key that is binded. You are free to delete this too if you
	want to free up some binds.


=========
Mode switch keys.
=========
CODE:
	bind KP_MINUS "vstr switch_mode_b"	//Special commands set Back
	bind KP_PLUS "vstr switch_mode"		//Special commands set Forward
	bind KP_ENTER "vstr mode_switch_05"	//Reset all binds to defult values
	bind 9 "vstr mode_switch_03"		//shortcut to admin mode
	bind 8 "vstr mode_switch_06"		//shortcut to message mode

Description:
	This is one of the more important parts of the script. It allows you to cycle through the modes of ths script.
	Keypad's - + and enter are the main keys for the script, and I highly insist that you do not tamper with these.
	The buttons 8 and 9, which can also be used on the keypad, are shortcut keys to quickly access the two
	important modes of the script; Admin mode and Message mode. Of corse admin mode requiers you to be an
	Admin to use. It is important that an admin has quick access to admin commands when dealing with lamers, spamers
	swarewers etc.

	The enter key is always going to be used, because it returns all the binds to their original values. And its
	on the Keypad not the normal enter because it easily access with the right thumb.

Edit how-to:
	It is in my opinion that these commands shoud not be messed with. They have been specificly placed on the
	keypad for quick access with the right hand.


=========
Default keys.
=========
CODE:
	set dkmouse3 "bind mouse3 +use"
	set dkmwheelup "bind mwheelup weapon 1"
	set dkmwheeldown "bind mwheeldown saberAttackCycle"
	set dkQ "bind q engage_duel"
	set dkE "bind e gunsleep"
	set dk1 "unbind 1"
	set dk2 "unbind 2"
	set dk3 "unbind 3"
	set dk4 "unbind 4"
	set dk5 "unbind 5"

Description:
	Here is where the default vaules for the main binds are stored. It is highly recommended that you edit these.
	The mouse binds; mouse3, mwheelup and mwheeldown are the ones that you shoud first consider to edit, this is because
	the example that is already in the script is diffrent from the default mouse keys layout.

	The current setting are my preferences, mouse3 (the mouse wheel button) is "use", mwheelup (roling the mouse wheel in 
	a upward motion) selects the saber for weapon and turns the saber on or off, mwheeldown (roling the wheel down) changes 
	the saber style.

Edit how-to:
	Its simple really, to edit change the command after the key name. Eg:
		set dkmouse3 "bind mouse3 +use"  <------ here you would change the +use part of the line.
	Say you wanted to change mouse3 to change style, to do so, you would replace +use with saberattackcycle
		set dkmouse3 "bind mouse3 saberattackcycle"
	After this guide I will list all of the commands that you would need to know.

=========
Merc and empower keys.
=========
CODE:
	set mk1 "bind 1 weapon 6" //these are the merc keys
	set mk2 "bind 2 weapprev"
	set mk3 "bind 3 weapnext"
	set mk4 "bind 4 weapon 4"
	set mk5 "bind 5 weapon 9"

	set ek1 "bind 1 force_speed" //these are the empower keys
	set ek2 "bind 2 forceprev"
	set ek3 "bind 3 forcenext"
	set ek4 "bind 4 force_protect"
	set ek5 "bind 5 force_heal"


Description:
	These 5 keys change for both merc and empower. Because my q and e keys are used
	for something else, I had to add "forcenext" and "forceprev" to change force.
	These keys can be removed and have your default keys remain.

Edit how-to:
	It is the same as the default keys in the section above.


=========
Admin keys.
=========
CODE:
	set akQ "bind q gunslay"
	set akE "bind e gunwake"

Description:
	These 2 keys change when you enter admin mode.

Edit how-to:
	same as before.


-------------------------saber.cfg------------------------------

==========
Custom saber colour
==========
CODE:
	set sb_colour_08 "set set_sbcolour vstr sb_colour_black;set nxt_sbcolour vstr sb_colour_09;set prv_sbcolour vstr sb_colour_07;echo [ ^5Black Saber ^7]"
	set sb_colour_black "sabercolor 1 1 1 1; sabercolor 2 1 1 1"

Description:
	Ok dont let the complexity of this section scare you. If you mess this up it dosent matter, all that will happen is 
	the whole line of code/script will echo in your concole. Nothing more. This allows you to change the colour of your saber
	to a custom colour of your choosing. This section only supports 12 saber colours, including your custom colours.

Edit how-to:
	A detailed description on how to edit this part is written inside the saber.cfg file, read the top part.


-------------------------model.cfg------------------------------

==========
Models
==========
CODE:
	set mname_00 "echo [^3Sephiroth^7]"
	set mname_01 "echo [^3Link^7]"
	set mname_02 "echo [^3Sephiroth 2^7]"
	set mname_03 "echo [^3Grayfox^7]"
	set mname_04 "echo [^3Scorpion^7]"
	set mname_05 "echo [^3SSJ ^3Goku^7]"
	set mname_06 "echo [^3Goku^7]"
	set mname_07 "echo [^3Snake^7]"
	set mname_08 "echo [^3Cloud^7]"

	set mmodel_00 "model sephiroth"
	set mmodel_01 "model link"
	set mmodel_02 "model sephiroth_jacket"
	set mmodel_03 "model grayfox"
	set mmodel_04 "model scorpion"
	set mmodel_05 "model goku_ssj"
	set mmodel_06 "model goku"
	set mmodel_07 "model snakev3"
	set mmodel_08 "model cloud_ac"

Description:
	Right this is the last bit of editing that you want to do for this script. Use all
	of the knowladge that you gained from the previous sections to aid you in this one.
	This part of the code is a shortcut for changeing models quickly, rather then typeing it
	into the concole. There are 9 avalible slots to place your models.

Edit how-to:
	Like the saber section, the how to on this is written inside the script.
	But remember to have the name and the model with their corrisponding 
	numbers. mname_00 > mmodel_00, mname_01 > mmodel_01, and so on so forth.
	You will have to know the name of the model inorder to use it.


=============================================================

Well thats it, hope this explains how everything works a bit more clearly.
If you still have any questions dont hesitate to email me, even I sometimes
have trouble following it when im editing because of its complexity.

=============================================================
	Command list
=============================================================

+use :use button, to activate doors, buttons etc.
saberattackcycle :change saber attack style.

gunsleep
gunwake
gunslay
gunsilence
gununsilence
gunpunish
gununpunish
gunmerc
gunempower
gunprotect
gunban
gunkick
gunmindtrick
gununmindtrick
gunghost
guntele

There are more...but it depends what you want really want. If you want a list of
commands type cmdlist into the concole for the complete list.

=============================================================
	Bind keys
=============================================================

F1 => 12
A => Z
1 => 0
-
=
Shift
Alt
Ctrl
TAB
KP_Plus
KP_Minus
KP_enter
[
]
del
HOME
PGUP
PGDOWN
MOUSE1
MOUSE2
MOUSE3
mwheelup
mwheeldown
uparrow
downarrow
leftarrow
rightarrow

