yellows111
/
icondumper2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A PS2 Icon parsing library or client
27 Commits 1 Branch 0 Tags 107 KiB
JavaScript 67.9%
HTML 32.1%
Go to file
yellows111 1b5f483df8 0.7.0: The Icebreaker update 
+ Now including support for CodeBreaker Save (CBS) format.
* CBS Parser function requires a function parameter that inflates data (zlib-style) given to it.
- Removed enabling/disabling strict mode from the reference client.
* Made timestamp objects consistant with every file format.
+ Added Pako to as a semi-optional dependancy to the HTML reference client.
* Disabling Pako will also disable CBS support in the HTML reference client.

Internals:
+ Now includes the RC4 cipherkey for deciphering CBS files.
+ Implemented an RC4 cipher function for deciphering CBS files.

Author comments:
One of the big five. Only one remains, and it's not going to be easy.
The road to an LZARI implementation spans a long distance, and the road there is bumpy.

- yellows
 		2023-12-07 14:14:07 +00:00
.github/workflows fix SPS/XPS crash, example icon 2023-12-03 17:32:26 +00:00
examples/example_001 fix SPS/XPS crash, example icon 2023-12-03 17:32:26 +00:00
.gitignore 0.7.0: The Icebreaker update 2023-12-07 14:14:07 +00:00
README.md 0.7.0: The Icebreaker update 2023-12-07 14:14:07 +00:00
gltf-exporter.js 0.7.0: The Icebreaker update 2023-12-07 14:14:07 +00:00
icon.js 0.7.0: The Icebreaker update 2023-12-07 14:14:07 +00:00
index.htm 0.7.0: The Icebreaker update 2023-12-07 14:14:07 +00:00
index.js 0.7.0: The Icebreaker update 2023-12-07 14:14:07 +00:00

README.md

icondumper2 (working title)

A JavaScript library (sorta) to read PS2 icons, and their related formats.

What is a "PS2 icon"?

A set of vertices with may or may not include a texture while defining colours for those vertices.

Why?

Current implementations had some issues with rendering some icons. These were mostly:

  • Not rendering any color for texture type 3.
  • Failing to decompress some specific RLE-compressed icons. (types above 8)
  • Requires writing/reading a specific format for successful output of data.

As of writing, there was no exporter that exists for the format that exhibited one of these problems.

icondumper2 is the result of me trying to avoid these problems.

What it supports:

  • EMS Memory Adapter export files (.psu)
  • PS3 virtual memory card export files (.psv)
  • SharkPort export files (.sps)
  • X-Port export files (.xps)
  • CodeBreaker Save export files (.cbs)
  • PS2 icons (.ico, .icn)
  • PS2D format (icon.sys)

What can it do:

  • Allow any file in a supported virtual filesystem (such as those from export files) to be read.
  • Warn of invalid icon.sys display names.
  • Export the icon model, with all seperate shapes included as a JavaScript Object.
  • CommonJS (that includes node!) module exporting while still being compatible with other JavaScript implementations.
  • Convert a 128x128x16 BGR5A1 bitmap to a standard RGB5A1 format.
  • Convert an icon or a set of icons to glTF 2, with textures saved as PNG.

What it doesn't do:

  • Create, manipulate or otherwise taint save files.
  • Modify any original input files.
  • Use any implementation-specific features.

Client compatibility:

The library requires use of const, let and class declarations.

Any JavaScript implementation should work if they support all three of these declarations.

Tested clients:

  • Chrome (or Blink-based browser) 49 (or higher) - HTML reference client
  • Firefox (or Gecko-based browser) 45 (or higher) - HTML reference client
  • Node.js 13 (or higher) - Example client and glTF 2 exporter.

Why "icondumper2"?

Because it replaced what was left of icondumper (1).

Included files:

File Description
icon.js The library itself.
index.js Node.js example client.
gltf-exporter.js Node.js client to export icons to glTF 2.
index.htm HTML reference client.

Included example files:

Directory Description Formats
/example_001 A tetrahedron with all 3 base colors set. PSU, SPS