MapleSim :: Custom Items

Custom Items

Custom items are image sets made by the users of BannedStory. They do not appear in the MapleStory game, although they can be based on original image sets.

BannedStory 3.0 now have support for custom items packed in zips as in BannedStory 2.x, as well as custom items placed in normal folders as in BannedStory 1.x. But thumbnails still need to be stored inside zip files as in BannedStory 2.x.

If you are going to use custom items packed in zips, you need to create the zips without compression, otherwise the custom item will not load in BannedStory. The same rule goes when adding thumbnails in the corresponding zip files for thumbnails.

Creating Custom Items

Custom items are composed of three important things:

Sprites: the different images that make up your custom item.
Thumbnail: an image representation of your custom item.
Data: an xml file that contains all the coordinates of your custom item.

The sprites and the data must be stored inside the custom item zip file or folder. This zip file or folder must be named as your custom item ID. The thumbnail is not needed inside the custom item zip file, but you can store it there for backup purposes.

Sprites

The making of the sprites is up to you. You can use whatever paint software to draw your own custom items. The only rule that apply when making sprites is that they can only be png images.

Thumbnail

The thumbnail is the image representation of your custom item. Although the dimensions of the thumbnails doesn’t matter, it is recommended to be less than 40x40 pixels. Only png images are accepted.

The thumbnail name must be the same as the ID of your custom item. If the thumbnail cannot be found, a warning icon will take its place.

Thumbnails are now stored in zip files located in the "thumbs" folder located on the root of the BannedStory program folder. Depending on the type of custom item you are making, you have to store the thumbnail inside the corresponding zip file that holds the thumbnails.

Data

The data is an xml file that holds all the required information to properly align each of the sprites you have made. This xml file has to be well written in order for it to work. You can use XMLPad to check that your xml file is well written.

It is advised to use the xml file of an existing item when making your custom item. Make a copy of an existing xml file and modify it to fit the needs of your custom item.

Reference Manual

MapleSim - Home of BannedStory