2003scape/rsc-sprites

🖼️ (de)serialize runescape classic entity, ui and texture images

rsc-sprites

(de)serialize runescape classic entity, ui and texture images.

IMAGE COLLAGE

install

$ npm install @2003scape/rsc-sprites

example

api

entitySprites = new EntitySprites({ animations })

create a new entity sprite (de)serializer (for entity jag and mem files). these are collections of frames for monster, character and equipment graphics.

entitySprites.loadJag(buffer)

entitySprites.loadMem(buffer)

prepare .jag and .mem buffers to be parsed. any sprites loaded with entitySprites.loadMem will have sprite.members = true.

entitySprites.parseArchives()

populate entitySprites.sprites with frames of canvas objects.

entitySprites.getAnimationSprite(id, overlay?, skinColour?)

entitySprites.toJag()

entitySprites.toMem()

return an entities jag/mem archive.

mediaSprites = new MediaSprites({ items, projectileSprite }, ui?)

create a new media sprite (de)serializer. these are images of interface items (buttons, arrows) and inventory items. ui specifies the filenames, sprite offsets and amounts for interface sprites hard-coded into the client:

    // refers to "splat.dat"
    splat: {
        offset: 11,
        sprites: 3
    },
    // etc.

this defaults to the interface sprites found in media58.jag for mudclient204 (./res/media-offsets.json).

mediaSprites.loadArchive(buffer)

load and prepare a media jag archive buffer.

mediaSprites.getSpriteById(id)

get a media sprite canvas by the id used in the client.

mediaSprites.getSpriteByItemId(itemId)

get a colourized item sprite canvas based on its id (index in config.items).

license

Copyright 2020 2003Scape Team

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

rsc-sprites's Issues

Looking for more information, happy to contribute to docs

Hello!

I am currently attempting to serialize some custom sprites to add into the rsc-server. Ive tried walking through the code and for whatever reason I have been unsuccessful in dumping the sprites from the entity .jag to determine what format I need to arrange the new assets in to serialize.

Effectively I want to replace the main character chest, legs, and head1 to play with implementing a new character design.

I have been able to identify that I likely need to replace the head1.dat file etc inside of the .jag, which I believe the .dat to be a file that contains the array of canvas objects for the animation, but I'm not sure if there is a way to serialize the images together in a cohesive way to create that .dat.

Ive been an RSC player since 2000 and continued playing private servers into 2014.

If I can figure the process out, I'd love to add to the docs for future developers who might stumble upon the repos!

TIA!