https://github.com/HaxeFoundation/format

Various files formats support for Haxe
https://github.com/HaxeFoundation/format

Last synced: 6 days ago
JSON representation

Various files formats support for Haxe

• Host: GitHub
• URL: https://github.com/HaxeFoundation/format
• Owner: HaxeFoundation
• Created: 2013-05-28T05:52:09.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-05-26T10:06:11.000Z (6 months ago)
• Last Synced: 2024-08-02T07:24:47.156Z (3 months ago)
• Language: Haxe
• Homepage:
• Size: 1.75 MB
• Stars: 128
• Watchers: 19
• Forks: 59
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.txt

Awesome Lists containing this project

• awesome-game-engine-dev - Format - Various files formats support for Haxe. (Libraries / Haxe)

README

        
[![TravisCI Build Status](https://travis-ci.org/HaxeFoundation/format.svg?branch=master)](https://travis-ci.org/HaxeFoundation/format)

The `format` library contains support for different file-formats for the Haxe programming language.

Formats

=======

Currently supported formats are :

| Format | Description | Reader | Writer |

|---|---|---|---|

| ABC | Flash AS3 bytecode format | ☑ | ☑ |

| AGAL | Adobe Shader Assembler for Stage3D | ❌ | ☑ |

| AMF | Flash serialized object | ☑ | ☑ |

| AS1 | Adobe ActionScript1-2 bytecode in SWF | ☑ | ❌ |

| BMP | Bitmap Image format | ☑ | ☑ |

| ELF | Executable and Linkable Format | ☑ | ❌ |

| FLV | Flash Video | ☑ | ☑ |

| GIF | Image file format | ☑ | ☑ |

| GZ | Compressed file | ☑ | ❌ |

| HL | HashLink | ☑ | ❌ |

| ICO | Windows ICO/CUR File format | ☑ | ❌ |

| JPG | Image file format | ❌ | ☑ |

| LZ4 | Compressed file | ☑ | ❌ |

| MAP | Source Maps | ☑ | ❌ |

| MP3 | Compressed audio | ☑ | ☑ |

| NEKO | NekoVM bytecode | ☑ | ❌ |

| PBJ | PixelBender Binary file | ☑ | ☑ |

| PDF | Only generic file structure and partial decryption | ☑ | ❌ |

| PEX | Particle effect format | ☑ | ❌ |

| PNG | Image file format | ☑ | ☑ |

| SWF | Flash file format | ☑ | ☑ |

| TAR | Compressed Archive | ☑ | ☑ |

| TGA | TARGA Image file format; Reader/Writer does not support developer data chunk; Writer does not support RLE encoding | ☑ | ☑ |

| TGZ | TAR+GZ Archive | ☑ | ❌ |

| WAV | Raw sound | ☑ | ☑ |

| ZIP | Compressed Archive | ☑ | ☑ |

Documentation

=============

Automatically generated API documentation is here: https://haxefoundation.github.io/format/format/

Installation

============

Available on haxelib, simply run the following command : `haxelib install format`. To use the library, simply add `-lib format` to your commandline parameters.

Package Structure

=================

Each format lies in its own package, for example `format.pdf` contains classes for PDF.

The `format.tools` package contains some tools that might be shared by several formats but don't belong to a specific one.

Each format must provide the following files :

  * one `Data.hx` file that contains only data structures / enums used by the format. If there are really a lot, they can be separated into several files, but it's often easier for the end user to only have to do one single `import format.xxx.Data` to access to all the defined types.

  * one `Reader.hx` class which enables reading the file format from an `haxe.io.Input`

  * one `Writer.hx` class which enables writing the file format to an `haxe.io.Output`

  * some other classes that might be necessary for manipulating the data structures

It's important in particular that the data structures storing the decoded information are separated from the actual classes manipulating it. This enables full access to all the file format infos and the ability to easily write libraries that manipulate the format, even if later the Reader implementation is changed for example.

Contributing

============

We're accepting contributions if they are following the package structure rules (see above), please send them as Pull Requests.