Custom Items - Revision history

Wolfeh: /* Files Configured Correctly, sprite does not show up in-game */ Capitalization~

2016-09-06T04:09:44Z

‎Files Configured Correctly, sprite does not show up in-game: Capitalization~

Wolfeh: /* Defining Items clientside (For New Clients) */ Must. Add. Punctuation. Grammar cleanup. Also added how to find sprite names to use as unidentifiedResourceName's

2016-09-06T04:04:23Z

‎Defining Items clientside (For New Clients): Must. Add. Punctuation. Grammar cleanup. Also added how to find sprite names to use as unidentifiedResourceName's

Wolfeh: /* accessoryid.lub */

2016-09-06T03:53:52Z

‎accessoryid.lub

Wolfeh: /* Defining Item clientside (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a) */ Added bit accname and accessoryid.

2016-09-06T03:53:32Z

‎Defining Item clientside (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a): Added bit accname and accessoryid.

Wolfeh: Removed xray bit. That project is long dead and we also no longer need to compile and decompile files thanks to newer diffs that load luas.

2016-09-06T03:50:49Z

Removed xray bit. That project is long dead and we also no longer need to compile and decompile files thanks to newer diffs that load luas.

Wolfeh: /* Less Than 6 Files */

2016-09-06T03:13:23Z

‎Less Than 6 Files

Wolfeh: /* Allocating Items on Client Side */

2016-09-06T03:12:58Z

‎Allocating Items on Client Side

Wolfeh: /* Allocating Items on Client Side */ Removed bit about item having 4 files, there should almost always be 6 files except for garments, accessories, and typically old sprites. Included a section for if there is less than that. Cleaned up extensively.

2016-09-06T03:12:28Z

‎Allocating Items on Client Side: Removed bit about item having 4 files, there should almost always be 6 files except for garments, accessories, and typically old sprites. Included a section for if there is less than that. Cleaned up extensively.

Wolfeh: /* Weapon Sprite Solution (For New Clients) */ Removed underscore. This was an old (and I mean -old-) troubleshooting method that was thought to work. It really doesn't. It's just an extra character for the client to read.

2016-09-06T02:39:22Z

‎Weapon Sprite Solution (For New Clients): Removed underscore. This was an old (and I mean -old-) troubleshooting method that was thought to work. It really doesn't. It's just an extra character for the client to read.

Wolfeh: /* Unknown Item */ Fixed it.

2016-09-06T02:37:30Z

‎Unknown Item: Fixed it.

@@ Line 563: / Line 563: @@
 If your item's name is unknown item and it has an apple icon, refer to [[Custom_Items#Defining_Item_clientside_.28Renewal_Clients_.3C.3D_2012-04-10a_.26_Main_Clients_.3C.3D_2012-07-10a.29|Defining Items Clientside]] and make sure you added the item to each and every file, or just iteminfo.lua for a newer client.
-==Files Configured Correctly, sprite does not show up in-game==
+==Files Configured Correctly, Sprite Still Does Not Show up In-game==
 If you do not have your sprites and files compressed into a GRF, you will need to make sure your client is diffed to read your data folder first.
 [[Category:Database]]
 [[Category:Data]]
 [[Category:Customization]]

@@ Line 288: / Line 288: @@
 =Defining Items clientside (For New Clients)=
-If your client date is newer than specified above then you need to specify all the above item information in 1 file
+If your client date is newer than specified above then you need to specify all the above item information in 1 file.
 ==System/ItemInfo.lub==
 Syntax:
   [<item id>] = {
@@ Line 307: / Line 306: @@
 You can also put the different values in DescriptionName in separate lines.
-Example: Lets say i want to add a weapon to item id 25000 - a One handed sword named Devastator with 3 slots & the image files & drop sprite files are all named Black_Sword.* . Also i want to display a Sword when not magnified.
+Example: Lets say I want to add a weapon to item id 25000 - a One-handed sword named Devastator with 3 slots and the image/drop sprite files are all named Black_Sword.* . Also I want to display a Sword when not identified.
   [25000] = {
@@ Line 327: / Line 326: @@
      ClassNum = 2
    },
 = Allocating Items on Client Side =

@@ Line 284: / Line 284: @@
    [ACCESSORY_IDs.ACCESSORY_ITEM_NAME] = "Item_Name",
 ==accessoryid.lub==
-This is where the viewid for your item can be found. It can be located in the same folder as accname.lub. It is as follows:
+This is where the view ID for your item can be found. It can be located in the same folder as accname.lub. It is as follows:
    ACCESSORY_ITEM_NAME = ViewID#,

@@ Line 264: / Line 264: @@
   ItemID#
   Item Description Line 1
-  Item Description Line 2
+  Item Description Line 2 (And so on)
+  #
-You can use any amount of lines for the description. If your description contains a #, make sure it is followed by a space character.
+You can use any amount of lines for the description. If your description contains a #, make sure it is followed by a space character. You can look at existing items for an idea of how to format a description.
 ==idnum2itemresnametable.txt==
-This file sets the inventory and drop-sprite for an the item. Item is defined as follows:
+This file sets the inventory and drop-sprite for the item. Item is defined as follows:
   ItemID#SpriteName#
 The SpriteName is the name of the files in collection and item folders inside texture and the ones inside sprite folder. If you want to use the look of an another item, search for it's id and copy the sprite name from there.
@@ Line 280: / Line 280: @@
 * num2itemdisplaynametable.txt
 * num2itemresnametable.txt
 =Defining Items clientside (For New Clients)=

@@ Line 363: / Line 363: @@
 ==Less Than 6 Files==
 In rare cases or for garment and accessory items, you may have less than 6 files to place. For a garment or accessory, you do not need a .spr and .act because these items are not visible on a character, therefore they do not require a .spr or .act file. For weapons, headgears, and shields, you should have 6 files. If you do not, you will have to create the missing files yourself. Especially for old sprites, the spriter may have just made the sprites and made no collection image, item image, or drop sprite. See [[Spriting]] on how to create these yourself.
 =Modifications=

@@ Line 362: / Line 362: @@
 ==Less Than 6 Files==
-In rare cases or for garment and accessory items, you may have less than 6 files to place. For a garment or accessory, you do not need a spr and act because these items are not visible on a character, therefore they do not require a .spr or .act file. For weapons, headgears, and shields, you should have 6 files. If you do not, you will have to create the missing files yourself. Especially for old sprites, the spriter may have just made the sprites and made no collection image, item image, or drop sprite. See [[Spriting]] on how to create these yourself.
+In rare cases or for garment and accessory items, you may have less than 6 files to place. For a garment or accessory, you do not need a .spr and .act because these items are not visible on a character, therefore they do not require a .spr or .act file. For weapons, headgears, and shields, you should have 6 files. If you do not, you will have to create the missing files yourself. Especially for old sprites, the spriter may have just made the sprites and made no collection image, item image, or drop sprite. See [[Spriting]] on how to create these yourself.
 = View IDs, Having A Custom Headgear Without Xray =

@@ Line 323: / Line 323: @@
 = Allocating Items on Client Side =
-Most custom items will have 6 files (if yours does not, see [[Allocating_Items_on_Client_Side#Less_Than_6_Files|Less Than 6 Files]]):
+Most custom items will have 6 files (if yours does not, see [[Custom_Items#Less_Than_6_Files|Less Than 6 Files]]):
 ) Drop sprite -> Helmet_drop.spr
 ) Drop act file -> Helmet_drop.act

@@ Line 323: / Line 323: @@
 = Allocating Items on Client Side =
-Your custom item will have 4 (6 in case its a headgear or garment) files:
+Most custom items will have 6 files (if yours does not, see [[Allocating_Items_on_Client_Side#Less_Than_6_Files|Less Than 6 Files]]):
 ) Drop sprite -> Helmet_drop.spr
 ) Drop act file -> Helmet_drop.act
@@ Line 331: / Line 331: @@
 ) Headgear View act file -> Helmet.act
-Lets say i downloaded a custom item called Helmet which serves as a headgear and the above six files were in them.
+Lets say I downloaded a custom item called Helmet which serves as a headgear and the above six files were in them.
-==Step 1:==
+==Sprite Locations==
-We place the first four files based on what we specified in id2numresnametable.txt (IdentifiedResourceName in Iteminfo.lub).
+We place the six files in the following folders
-For our example lets say i used "Helmet" as the resource name :
- i)   Copy Helmet_drop.spr to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.spr
- ii)  Copy Helmet_drop.act to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.act
- iii) Copy Helmet_item.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\item\Helmet.bmp
- iv)  Copy Helmet_collection.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\collection\Helmet.bmp
-==Step 2 (only for Headgears):==
-For displaying headgear on the character there will be two additional files (sprite & act) or 4 if the sprite author intended for a separate set of files for male & female. In my example i have considered the first scenario.
-The filename for headgear sprite are now specified in accname.lua file <b>(details of which is available in the [[Custom_Items#View_IDs.2C_Having_A_Custom_Headgear_Without_Xray|View IDs Section]])</b>
+* Copy Helmet_drop.spr to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.spr
-lets say i used
+If the process confused you, [http://www.mediafire.com/?8lzt4cbot100w44 here is an example folder], the sprite is done by drkangel. The folder is virus free.
- [ACCESSORY_IDs.HELMET] = "_Helmet",
-then we need to:
- i)   Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.spr (Female)
- ii)  Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.act
- iii) Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.spr (Male)
- iv)  Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.act
-−
-Now it is ready to be used provided you have added entries properly to the lua files.
 ==Specifications of the files==
 ) Drop sprites - ideally have 1 frame & its act file will be just an empty act (only header will be there inside)
-) Equip sprites - typically have 3+ frames to show images for various orientations & its act file will have the info on where to place each frame.
+) Item bmp - 24x24 size 256 bit bmp file. Magenta (FF00FF hexadecimal value) background.
-−
-−
 ) Item bmp - 24x24 size 256 bit bmp file.
-−
 ) Collection bmp - 75x100 size bmp file (usually 256 bit but there is no restriction)
-<b>How to differentiate between sprite files?</b>
+==How to differentiate between sprite files?==
 Open both sprite files in [http://ratemyserver.net/download_agent.php?type=1&file_num=10 Spr Conview]. The number of frames in the files can be seen at bottom (Sprite: <currentframe>/<total>). If it says Sprite: 1/1 then its a drop sprite and the other is equip sprite.
@@ Line 374: / Line 361: @@
 Sometimes what sprite authors do is they simply copy the original sprite itself to make a drop sprite. In this case you will see both of them as identical when opened in Spr Conview & we don't need to worry about which one is which (since they are the same).
-If the process confused you, [http://www.mediafire.com/?8lzt4cbot100w44 here is an example folder], the sprite is done by drkangel. The folder is virus free.
+==Less Than 6 Files==
 = View IDs, Having A Custom Headgear Without Xray =

@@ Line 581: / Line 581: @@
 OK Back to topic. so I add my entry like shown below.
-  [Weapon_IDs.WEAPONTYPE_Oriental_Sword] = "_Oriental"
+  [Weapon_IDs.WEAPONTYPE_Oriental_Sword] = "Oriental"
 Lastly come down further in weapontable.lub and you see the last table called <b>Expansion_Weapon_IDs</b>.<br>
@@ Line 591: / Line 591: @@
 With this your weapon sprite will become visible while attacking.
 =Troubleshooting=
 ==File Not Found "Cannot find File : path\to\file\filename.extension"==

@@ Line 595: / Line 595: @@
 As the error states, the client cannot find the file required to display the sprite, act, collection, or item image for the item. Make sure you put your file in the right place and that it is named correctly.
 ==Unknown Item==
-If your item's name is unknown item and it has an apple icon, refer to [[Custom_Items#Defining_Items_Clientside|Defining Items Clientside]] and make sure you added the item to each and every file, or just iteminfo.lua for a newer client.
+If your item's name is unknown item and it has an apple icon, refer to [[Custom_Items#Defining_Item_clientside_.28Renewal_Clients_.3C.3D_2012-04-10a_.26_Main_Clients_.3C.3D_2012-07-10a.29|Defining Items Clientside]] and make sure you added the item to each and every file, or just iteminfo.lua for a newer client.
 ==Files Configured Correctly, sprite does not show up in-game==