[Release] Custom Job & Custom Shield Patches

[Neo-Mind 264]

Well a few people know i have been working on these. So here goes.

 

Did I hear right?

 

1. Yes it is what you are thinking. The Custom Job patch allow you to modify the existing jobs and add new jobs 

    in a fashion similar to HeliumRO's Xray Clients (and some extra stuff u will see below) but using lua files.

 

2. Similarly Custom Shield Patch allows you to throw the existing 4 shield limit out the door and modify existing as well as 

   add more shield equipment types to your liking using lua files.

 

3. For now I have tested them out on a set of clients (for others the logic followed were the same 

   so I didn't bother with the rest). Ofcourse if any bug comes up I will work on fixing them.

   

4. Patches were made with existing patches in mind and therefore will not affect any and existing diffs present

   in a client you use. Infact you are supposed to use these last only.

 

5. Custom Job Patch has also an override for Class names based on gender. For it to work Langtype Korean Jobname Fix

   is expected to be enabled (for xDiff patches it is a part of Translate to English patch)

 

 

6. So is there a limit ? yes for now i have limited them as max shields to 10 and max job id to 4300.

 

So how does it work ?

 

1. Get the xdiff file for your client version (from the link below)

 

2. Get the lua files (also from the link below)

 

3. Modify/Add entries to the lua files (Format is specified below)

 

4. Load your client and xdiff file in xDiffPatcher

 

5. Let it Rip!... i mean Patch!!

 

6. And last but not least place the lua files in their proper locations.

 

Lua File Formats - Custom Job Patch

Custom Job Patch makes use of 7 lua files (similar to the various txt files Xray client had).They need to be present in the luafiles514/lua files/admin path.

 

1) PCIdentity.lua:

  This file is already present in the official GRF but we are going to use a modified version of that one.

  All Job Sprites have a corresponding Job ID (including costumes and Job Mounts). This file defines all of them

  and their relationships to each other.

  This is done with the help of 3 tables =>

  i) pcJobTbl (mandatory):

 This is where the job id value is defined and mapped to a string for identification

JT_KAGEROU = 4211, -- 4211 is the job id for kagerou class   

  ii) Halter_Map :

This is where you specify which job id is the job mount of which class. Ofcourse if you dont 

plan to add a mount sprite for a class you can ignore this one.

[pcJobTbl.JT_KAGEROU] = pcJobTbl.JH_KAGEROU, -- maps kagerou job to his frog mounted sprite

  iii) Shrink_Tbl :

This is list of job IDs that need to be ... shrunk i.e. specify all Baby Jobs here.

pcJobTbl.JT_SWORDSMAN_B, -- will include Baby Swordsman in the list 

 

2) PCPaths.lua:

   Lua equivalent of class_tab.txt . Defines the prefix string used for each class to get its sprite & act file path.

   i.e. prefix in => /data/sprite/Àΰ£Á·/¸öÅë/<gender>/<prefix>_<gender>.spr (& act as well).

   This is done with the help of two tables (only one of which needs to be filled for a class).

   

   i)  PCStitchTbl :

     If your job uses a completely new sprite with a new filename then you can assign it in this table.

[pcJobTbl.JT_SWORDMAN] = "°Ë»ç" -- Prefix for Swordsman	

   ii) PCStitchInheritTbl :

     If your job is sharing an existing sprite path already used by a job specified in PCStitchTBl then you can

simply connect them in this table (target job id inherits from source job id).

[pcJobTbl.JT_SWORDMAN_H] = pcJobTbl.JT_SWORDMAN, --JT_SWORDMAN_H is High Swordsman which uses                                                 --same sprite as Swordsman 

  All of the remaining lua files follow a similar pattern with one table for direct assignment and the other one for inheriting value from another job id

3) PCImfs.lua:

Lua equivalent of imf_tab.txt . Defines the prefix string for imf files of each class.

i)  PCImfTbl :

[pcJobTbl.JT_KNIGHT] = "񃯇",	-- Prefix for Knight		

ii) PCImfInheritTbl :

[pcJobTbl.JT_KNIGHT_H] = pcJobTbl.JT_KNIGHT, -- JT_KNIGHT_H is Lord Knight and has the same                                             -- imf as Knight class.

4) PCHands.lua:

Lua equivalent of reality_dir_tab.txt. Defines the prefix strings used for Weapons and Shields of each class

i) PCHandsTbl :

[pcJobTbl.JT_ASSASSIN] = "¾î¼¼½Å¾î¼¼½Å", -- Prefix for Assassin		 

ii) PCHandsInheritTbl :

[pcJobTbl.JT_GUILLOTINE_CROSS] = pcJobTbl.JT_ASSASSIN, -- Guillotine Cross picks up                                  --weapons/shields from the same path as Assassin class.

5) PCPals.lua

  Lua equivalent of reality_tab.txt. Defines the prefix strings for the body palettes.

i) PCPalTbl:

[pcJobTbl.JT_MAGICIAN] = "¸¶¹ý»ç", -- prefix for Mage		                         

ii) PCPalInheritTbl:

[pcJobTbl.JT_MAGICIAN_H] = pcJobTbl.JT_MAGICIAN, -- High Mage uses same prefix as Mage class.

 

6) PCNames.lua

  Lua equivalent of monstrosity_tab.txt (in part since mobs are defined by jobname.lua) . As the file name says this is where you define all your class names. Reason i saved this for last is because this file is slightly different from the previous 4. Here you can define the class name seperately for both genders.

For male classes =>

i) PCJobNameTbl :

[pcJobTbl.JT_WARLOCK] = "Warlock", -- Kind of obvious right?	

ii) PCJobNameInheritTbl :

[pcJobTbl.JT_WARLOCK_H] = pcJobTbl.JT_WARLOCK, -- JT_WARLOCK_H is Transcendent version of                                         -- warlock class and ofcourse it will have same name

For female classes =>

iii) PCJobNameTbl_F :

[pcJobTbl.JT_WARLOCK] = "Witch", -- Now the female Warlock will be called Witch

iv) PCJobNameInheritTbl_F :

[pcJobTbl.JT_WARLOCK_H] = pcJobTbl.JT_WARLOCK, -- Same for Transcendent warlock	   

By default if your gender is female and there is no names defined using either iii) or iv) above then it checks in the tables for male gender.

7) PCFuncs.lua

Contains Necessary functions used by the client - DO NOT TOUCH THIS FILE unless you know what you are doing!!!

 

Lua File Formats - Custom Shield Patch

Custom Shield Patch makes use of 2 lua files as specified below. They need to be present in luafiles514/lua files/datainfo folder.

 

1) ShieldTable.lua :

This lua file is the only one you need to configure. It contains 3 tables and is similar in format to WeaponTable.lua

i) Shield_IDs :

Defines a list of IDs which includes both Shield Types & Item IDs used by shield items in item_db.txt. Shield Items can only start from item id 2101 onwards so anything lesser than that will be considered as a shield type id. To distinguish between them we use the ST (Shield Type) and SI (Shield Item) prefixes.

ST_MSHIELD = 4,	-- Mirror Shield TypeSI_Platinum_Shield = 2122, -- Platinum Shield's Item ID		 

ii) ShieldNameTable :

Here we assign suffix strings for Shield Types i.e. shield suffix in => /data/sprite/¹æÆÐ/<hand prefix>_<gender>_<shield suffix>.spr

[Shield_IDs.ST_MSHIELD] = "_¹Ì·¯½¯µå", --Suffix for Mirror shield 

iii) ShieldMapTable :

Here we specify which Shield Type is used by each of the Shield Items.

[Shield_IDs.SI_Platinum_Shield]	= Shield_IDs.ST_MSHIELD, -- Platinum Shield uses                                                             -- Mirror Shield sprite.

2) ShieldTable_F.lua :

Contains Necessary functions used by the client - DO NOT TOUCH THIS FILE unless you know what you are doing!!!

 

 

Ok.. So Where do i get the files?

Download link

 

 

Final Note

If you have any issues or doubts about the xDiff files or Lua files (I expect some in this department) let me know. So Enjoy

Edited August 11, 2013 by NeoMind

[Uzieal 89]

This is more awesome then I imagined it would be! It is a long read but after I sleep (since I haven't) I am going to attempt to test this out  

 

+1 this if you think its awesome~   

[KeiKun 8]

Booo! JK!
 

Well a few people know i have been working on these. So here goes.

 

/me is one of them

 

 

still reviewing and trying to extract what this topic says

i wish you can add the screenshot you gave me with the priest look a like job with wing ~

 

anyway

 

great job~ with posting the topic

[Neo-Mind 264]

hmm good idea ill upload screenshot with a custom job & custom shield soon

[xienne15 5]

screenshot?

[Judas 100]

awesome job =) let the fun being 

[Reaper_san 3]

simply AWESOME!

 

but... i tried to use it with regexe 2013 06 05.... and have problems with the shields diff
so only check te custom jobs diff... and have this message: "ReqPCPath call a nill value"
 

[Neo-Mind 264]

These patches need seperate lua files that i have provided in the repository link. did you get them as well?

 

I got busy with some of the xdiff bug fixes (official ones) so it got delayed but I am making a video tutorial to explain things better.

[Reaper_san 3]

i don't know how, but the problem with te custom jobs was solved when i change the exe

but still have problems when i check the custom shield diff,
it appears when click "patch" in the xDiffPatcher and close it
(is not a lua problem, i think is on the diff ._.). here are a screenshot
 

Edited August 16, 2013 by Reaper_san

[Reaper_san 3]

Edited August 16, 2013 by Reaper_san

[Neo-Mind 264]

uh did u mix up the diff files . mine doesn't have the other patches inside.

[Reaper_san 3]

it's easy to do
but the error appears even if i don't mix the diff files

using only your file, i still have errors with the custom shield diff.
(help me plz, and i share my custom files with you, for some features ... because i don't know how to do diff files ._.)

PD: do you understand my english? jajajajaa
(because i speak 100% spanish, and 90% english >_< )

Edited August 18, 2013 by Reaper_san

[Neo-Mind 264]

the error you showed me i think happened because you merged the two xdiff files,

mine uses ids from 0 onwards which is also used by another patch in the other one which is probably why u caught the error.

What error are you getting using it seperately.

[madtoyz 2]

what and amazing work you do NeoMind.

after this designer will make some sprite of shield and jobs 

[Reaper_san 3]

the error you showed me i think happened because you merged the two xdiff files,

mine uses ids from 0 onwards which is also used by another patch in the other one which is probably why u caught the error.

What error are you getting using it seperately.

 i got the same error

which ragexe may i use??

i think it is the problem, the other error with custom jobs disappear when i use another ragexe (up 2013-07)

 

thx

 

[Louis T Steinhil 4]

Neomind: Does your patch for custom job and shield support the login screen window and cancel button?

[Neo-Mind 264]

 

the error you showed me i think happened because you merged the two xdiff files,

mine uses ids from 0 onwards which is also used by another patch in the other one which is probably why u caught the error.

What error are you getting using it seperately.

 i got the same error

which ragexe may i use??

i think it is the problem, the other error with custom jobs disappear when i use another ragexe (up 2013-07)

 

thx

hmm strange alright ill double check it today.

Anyways i have been bit lazy with making a guide to use this (partially because i wanted it to also include what you need for server side to add custom jobs - wiki is bit outdated).

 

Neomind: Does your patch for custom job and shield support the login screen window and cancel button?

It should, since one doesn't interfere with the code of the other.

[Louis T Steinhil 4]

ok thanks for the information.

[Reaper_san 3]

NeoMind

 

i´m using "XVI32" program to make my own custom hex mods
because i don't know how to make a xdif file xD
if I knew, i think can fix the problem by myself
and help you

where i can learn how to do it?
(i want to release my customs too, like you )

Edited August 27, 2013 by Reaper_san

[dhaisuke 1]

does anyone had try this?

[kyeme 71]

Shield not showing? Im using 2012-07-16aragexe w/ custom shield diff

[Mhalicot 392]

Error. I am using 20130807 client

 

Can't apply the patch

 

Exception Source:      mscorlibException Type:        System.IO.EndOfStreamExceptionException Message:     Unable to read beyond the end of the stream.Exception Target Site: ReadByte   at System.IO.BinaryReader.ReadByte()   at xDiffPatcher.DiffFile.ApplyPatch(DiffPatch patch, Byte[]& buf, BinaryReader r)   at xDiffPatcher.DiffFile.Patch(String inputFile, String fileName)   at xDiffPatcher.frmMain.btnSave_Click(Object sender, EventArgs e)   at System.Windows.Forms.Control.OnClick(EventArgs e)   at System.Windows.Forms.Button.OnClick(EventArgs e)   at System.Windows.Forms.Button.OnMouseUp(MouseEventArgs mevent)   at System.Windows.Forms.Control.WmMouseUp(Message& m, MouseButtons button, Int32 clicks)   at System.Windows.Forms.Control.WndProc(Message& m)   at System.Windows.Forms.ButtonBase.WndProc(Message& m)   at System.Windows.Forms.Button.WndProc(Message& m)   at System.Windows.Forms.Control.ControlNativeWindow.OnMessage(Message& m)   at System.Windows.Forms.Control.ControlNativeWindow.WndProc(Message& m)   at System.Windows.Forms.NativeWindow.Callback(IntPtr hWnd, Int32 msg, IntPtr wparam, IntPtr lparam)Additional info:Diff File: 2013-08-07aRagexe.xdiffPatches:[x] Enable Custom Jobs[x] Enable Custom Shields

[Chiron 5]

Unable to read beyond the end of the stream.

 

Just a Guess:

 

xDiff file (That only occurs with Custom Shield) contains few inexistent byte offset (Beyond the end of executable). Then, the parser can't read and throw that error.

 

"Pure" 2013 - 07 - 31c

 

 

 

Last byte offset: 6477A0

First "Strange" offset: 647e96

 

Correct me if i'm wrong. 

Edited September 25, 2013 by Chiron

[Neo-Mind 264]

hmm let me check it out.

[Lanz 0]

Any update bout this?

 

Using this client: 20130807