By Slider
Date: 10-12-2004
******************************************
Jedi Academy Multiplayer Game Modification
******************************************
//////////////////////
Title: JA+ Client Side Plugin v1.2
//////////////////////
Title : JA+ Client side Plugin
Authors : Slider
E-Mail : slider744@hotmail.com
website : http://japlus.fragism.com/
Date Released : 19/09/2004
Description : This version of the JA+ Client side Plugin is designed for the server side JA+ mod greater or equal than v2.0
OS : Windows and MAC
Mod Type : Client Side Plugin
JA+ is a server side Mod for windows, linux and Mac which has the possibility to get a Client side plugin with pk3 files.
this plugin is designed to give UI, animation and feature enhancement to your client side game.
You are not obligated to install the plugins with the JA+ server side part to run a JA+ server.
If the JA+ server you play is PURE server (sv_pure 1), all players and the server will have to install this plugins to join this server.
so in this case the JA+ server is not server side anymore.
If the JA+ server you play is NOT PURE server (sv_pure 0), the server and players are not obligated to install this plugin to join the game.
So in this case the JA+ server remains a server side mod.
the server will recognize the players who have the plugins and will make them take advantage of it to have better animation, Ui and features.
The players who have not this plugins will be able to join but will not have those better things (and they won't see the difference with a normal server side JA+ ).
The fact that several players are running this plugin on a server where other players are not running it will not change and alter the gameplay of player.
PS: in sv_pure 0, all pk3 at client side can be used by the client: SO if the client has to many pk3, he may have problem with missing textures or joining the server.
Exemple of feature:
-MultiTaunt Sound and Multi Custom sounds in all gametype
- admin and clan channel autologin.
- AutoReplier integrated working with all languages.
- RGB sabers
- better smoothy moves thanks to the client side prediction
- Complete view of modelscale stystem with also scaling of sphere, shadow, saber....etc...
- Improved effects for the new moves, forces, attacks
- Improved UI menu
- Capability of allow/disallow Importants new feature provided by the plugin
- Complete Duel Non interference Code (Visual Ghost effect, smoothy player crossing)
- better JA+ items management ( flamethrower and grapple hook ...etc...)
///////////////////////////////////////////////////////////////////////////
How to install?
///////////////////////////////////////////////////////////////////////////
- it is very simple, you just have to
Delete all client side files ( .pk3, .cfg ..cgamex86.dll, uix86.dll.)of the old plugin versions in your gamedata/japlus folder
put all new files ( .pk3, .cfg , ....)provided with this mod in your gamedata/japlus folder
- Special Note for MAc install : please refer to the readme.txt inside the MAC_patch folder.
///////////////////////////////////////////////////////////////////////////
Features ADDED in all versions
///////////////////////////////////////////////////////////////////////////
***********************************
Features in 1.2
************************************
- MAC JA+ plugin now available:
- MultiTaunt Sound and Multi Custom sounds : in basejka, players sounds are very poor and they are always the same.
Now You can hear all custom sounds of the models (falling, death, taunt, taunt1, taunt2, taunt3, pain, ....etc...) when using this plugin.
see the list of all the sounds in this readme if you want to build custom models sounds.
- new client cmd : pluginDisable : allow/disallow some features in JA+ PLugin.
type : pluginDisable ID_Feature
to know all ID_Feature , just type the cmd without arguments
it will change the cp_pluginDisable cvar. this cvar is a bit value cvar that store your config for plugin feature disable.
By default the feature are all allowed.
- cvar cp_newDrainEfx removed. because this is now integrated in the cp_pluginDisable .
- AutoReplier integrated:
The JA+ Plugin provide an autoreplier system that doesn't require that your game be in english text to work.
The server must not disallow it if you want to use it.
Most messages are sent in private messages not to spam console.
you also can have many message for the same event that will be used randomly.
You just have to edit the file autoreplier.cfg with notepad and change the messages.
Then put this file in your japlus folder.
you can use the cvar cp_autoReplierFile to change the name of the default file.
While in game , you can use the cmd /reloadReplier to reload all messages from this config file.
Messages are autoReloaded at change map.
- all cycle admin cmd improved (admCmdNext, admCmdPrev, playerPrev, playerNext....) a lot in speed execution even if floodprotect is ON.
- using the plugin, admin guns will also works better even with floodprotect ON.
- new item in the setup menu video2:
-- cg_shadows (0,1,2 or 3 default 1)cvar accessible in the menu : to change the default behaviour of player shadows
-- cg_renderToTextureFX (0 or 1 default 1) cvar accessible in the menu : to reduce some laggy effects on several ATI video cards (protection sphere, cloak effect, push blur effect...etc...)
- Grapple Hook Improved:
you will be able to change your Hook Model with predifined models or the model you want (so moddlers can make their own hook model).
- cp_hookModel (0 , 1 or Path default 0): you need to reconnect the server so that the change be applied
0: predifiined model 0
1 : predifined model 1
Path : path pointing on the hook md3 model
exemple of Path: "models/items/g_hook/hook.md3" (so moddlers have fun creating new hook models :) )
- play_japlus.bat : script to start the game directly with the JA+ mod loaded. Put in your gamedata folder and execute it to start the game.
- death messages improved according to the method of death (MOD_FALLING, MOD_CRUSH, MOD_WATER, MOD_SLIME, MOD_LAVA).
those messages are also translated in the following languages (English, Spanish, French, German).
If you want that those message be loaded correctly you have to start your game directly under JA+ mod loaded
use the - play_japlus.bat : script to do it.
fix: autoreplier1.2Preview bug fixed when following duelers.
***********************************
Features in 1.1 :
************************************
- JAPLus is added to the server filter in the JOIN server menu
- JAplus scorboard updated with the number of times you died. it works only if you play on a JA+ server greater or equal than the 2.1 version.
- RGB sabers with menu enhancement and various style of line core , glow and trail (normal, flame, electricity,flame2, electricity2)
(works only with server JA+ greater or equal than v2.1).
- SP effect added for force sight
- cp_newDrainEfx (1 or 0 default 1) : active/disactivate the new wide drain effect. you must reconnect the server so that the new value is taken into consideration.
2 NEw force attacks:
- NEw SP Drain Grab attack (the sith Kiss :) ): use force drain with melee weapon in front of your ennemy
- NEw Jedi grab Push attack ( jedi tornado ) (only for jedi): use force push with melee weapon in front of your ennemy
you must have your force level greater or equal than 2
you can block those attacks with absorb if you are a jedi or force push (press push a lot of times) level 3 if you are a sith.
the server must all this attack with jp_allowSPForces 2 at server side.
a very nice effect is also provided with the client side plugin.
- several new SP force animation when you start to use forces (there is also some special effect using the client side plugin). (you must allow those move with jp_allowSPForces at server side)
- the ingame profile menu is improved with the moves list including all the new JA+ moves with animation showing the moves in the UI
- New hook model made by {OoJ}Vouksh{M} specially for JA+.
- Vote is Displaying now the new JA+ vote type like ampoll, sleep,.... without the buggy strings in left Top of the screen.
the JA+ vote are also accessible through the menu.
the server stop writing vote center screen messages when using this plugin version.
- Duel isolation Improved :
you can see other players names while they are dueling only if jp_duelAlpha > 0.
When you make a private duel in team gametype, you now don't see the sprite above player heads.
- Modelscale improved:
all spheres like boon or enlightement, or protect are also scaled according to the server scale factor.
- Server Load Page updated for gametype highlander with rule display.
- if you play on a JA+ server less than the 2.0 version, all the features in the plugin that cause important client bugs will be autoDesacticated in the client plugin.(like for example the duel isolation).
But remember that in all cases, the plugin is not made for JA+ server version less than the 2.0.
So you are not obligated to remove your plugin when joining an old JA+ server. The plugin will do the work for you :).
- Fix: if the modelscale is activated, the costom saberLength for blades belonging to the same saber are now well scaled according to the saberLength2,3,....etc...
- Fix : the basejka bug with some Buggy Vote strings display is now corrected for all Vote type.
***********************************
Features in 1.0:
************************************
- Grapple Hook: you have to bind it /bind X "+button12" where X is a Key.
Real grapple hook in the client side plugin.
in the JA+ server side hook version (if you don't use this plugin): the hook disengages itself if you stop pressing your binded hook key.
Now if you use the client side JA+ plugin, you can keep suspended if you stop pressing your binded hook key and
you will have to press your USE button to disengage the hook.
With the client side plugin enabled you can also see a real hook wire.
if you press again the binded hook key, you will be pulled again
if you press the walking button, you will make a hook repel move.
-FlameThrower : an effect is also available in the client side plugin when a player is burning and also for the flamejet effect itself.
- improved animations which was causing a laggy look without this plugin: for example : grapple move, meditate, the wall stick free mouse look, the yellow dfa mouse look , roll (with jp_fixroll 2 or 3)...etc...
- player names are now drawn with colors in your crosshair for ffa gametype.
- Improve the model scale system: with this client side plugin, saber are drawn with a lenght scaled on model scale factor defined by the server.
the player shadow is also scaled according to the model scale factor.
- all JA+ commands are added to the cmds list so that you can use the TAB key to complete a cmd name.
- several key added in the control menu under the "Ja+ controls" section.
-when your private duel ends, you start an orbital move around your player just at the death moment.
--Duel Isolation (Non interference): thanks to the plugin this feature is improved compared with the default server side behaviour:
**when you are in duel, you can't see other players and you are not influenced by other players weapons, force power use, explosions......
**if you aren't in duel, you see cloaked duelers. the degree of visibility of duelers is controled by jp_DuelAlpha.
**going through other players is also better here because client side predicted.
- autologgin for admin and clanpass with 2 client cvar cp_login and cp_clanPwd
- new RGB colors for player clothes in player menu creation (it can be used instead of the /amcolor cmd).
///////////////////////////////////////////////////////////////////////////
Client Commands added in PLugin
///////////////////////////////////////////////////////////////////////////
- pluginDisable ID_Feature : allow/disallow plugin features
if you type this cmd without any argument, you will have the list of all feature ID.
this cmd will change the value of the cvar cp_pluginDisable . So you don't have to make yourself the computation of the bit values.
Here are all the ID (the frist is 0)
Plugin_NewDrainEFX_needReconnection /*= 0*/, control the actication of the new drain effect. you need to reconnect server to take effect
Plugin_IgnoreAllPlayers_WhenInDuel, control if you will see other players when you are in duel
PLugin_EndDuel_Rotation, control the camaera spin activation around player at the end of your duel
Plugin_seeBlackSabers_needUserInfoUpdate, control if you want to see black sabers.
users using black saber need to change his saber so that the black colors be changed in orange.
Plugin_AutoReplier, control the activation of the autoreplier integrated in JA+ PLugin
- reloadReplier : will reload all messages config from the autoreplier config file (default "autoreplier.cfg").
///////////////////////////////////////////////////////////////////////////
Client side cvars
///////////////////////////////////////////////////////////////////////////
//-----------Password-------------------
- cp_login : put you council or knight or instructor password to be autologged in at server joining
- cp_clanPwd : put your clanpass here to me autologged in for clan team private speak.
This password is also needed for the CLan Taf Protection system configured at server side.
//--------------RGB saber-------------------
- cp_sbRGB2 , cp_sbRGB1 : bit value that store the RGB saber info to send to the server
- color2 , color1 : Id of the color type (blue, red, ....,black, various style of RGB core.
- ui_sbBlue2 - ui_sbGreen2 - ui_sbRed2 - ui_sbBlue1 - ui_sbGreen1 - ui_sbRed1 : float that save the UI RGB settings
//---------Other-----------
- cp_pluginDisable (bitvalue default 0): this cvar contains all the plugin feature disable config in one bitvalue cvar.
use the pluginDisable cmd to configure this cvar.
so the value 0 means that all features are allowed.
- cp_hookModel (0 , 1 or Path default 0): you will be able to change your Hook Model
you need to reconnect the server so that the change be applied
0: predifiined model 0
1 : predifined model 1
Path : path pointing on the hook md3 model
exemple of Path: "models/items/g_hook/hook.md3" (so moddlers have fun creating new hook models :) )
- cp_autoReplierFile (default "autoreplier.cfg") : the name of the autoreplier config file
///////////////////////////////////////////////////////////////////////////
Auto Replier
///////////////////////////////////////////////////////////////////////////
The JA+ Plugin provide an autoreplier system that doesn't require that your game be in english text to work.
The server must not disallow it if you want to use it.
Most messages are sent in private messages not to spam console.
(Don't forget the /ignore cmd if someone use it to send insult in private message)
you also can have many message for the same event that will be used randomly.
You just have to edit the file autoreplier.cfg with notepad and change the messages.
Then put this file in your japlus folder.
you can use the cvar cp_autoReplierFile to change the name of the default file.
While in game , you can use the cmd /reloadReplier to reload all messages from this config file.
Messages are autoReloaded at change map.
here is the list of all autoreplier message types :
Message type Mutiple Random MSG? comment
DUEL_START 1 when you begin a duel
DUEL_END_WIN 1 when you win a duel
DUEL_END_LOST 1 when you loose a duel
ON_SELF_ENTER 0 when you enter the game
ON_PLAYER_JOIN 1 when a Another player enter the game
///////////////////////////////////////////////////////////////////////////
MultiTaunt and Multi Custom Model sounds
///////////////////////////////////////////////////////////////////////////
The JA+ plugin enable to hear a lot of custum sounds defined in your skins or models pk3 files...
Here is the list of all sounds you can use :
"death1",
"death2",
"death3",
"jump1",
"pain25",
"pain50",
"pain75",
"pain100",
"falling1",
"choke1",
"choke2",
"choke3",
"gasp",
"land1",
"confuse1",
"confuse2",
"confuse3",
"pushed1",
"pushed2",
"pushed3",
//Taunt, Gloat and FLOURISH sounds
"taunt",
"taunt1",
"taunt2",
"taunt3",
"deflect1",
"deflect2",
"deflect3",
"gloat1",
"gloat2",
"gloat3",
"anger1",
"anger2",
"anger3",
"victory1",
"victory2",
"victory3",
**********************************
SPECIAL THANKS
**********************************
- special thanks to BlueMint for his startup screen based on a screenshot of the map Sunset on Coruscant (author: rgoer)....
- thanks also to BlueMint for his slogan "we all need more" :)
- also thanks to rgoer :) who accepted that his map be used ....
- also thanks to Phoenix to give his Hook model and also the code of his non interference duel from his Gen-X JK2 mod. The duel isolation code here is based on this code.
- thanks to Tidus for his Menu RBG clothes in player creation based on the OJP rgb menu in player creation made by Razorace.
- thanks also to Tidus for his help in the RGB saber menu (RGB sabers inspired by the OJP's one and TCK).
- in the various saber core line and trails, i used some images found in JK2 Sabers made by TCK and Chikyu-Jin
- special thanks to {OoJ}Vouksh{M} for his hook model dedicated to JA+ hook.
- special thanks to Accident for his permission to use his Autoreplier ideas for the plugin in order to have a Autoreplier working with all languages and not only english.