巫泽俊 > Archive-Rgssad > Archive::Rgssad

Download:
Archive-Rgssad-0.11.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.11   Source  

NAME ^

Archive::Rgssad - Provide an interface to rgssad and rgss2a archive files.

VERSION ^

Version 0.11

SYNOPSIS ^

    use Archive::Rgssad;

    my $rgssad = Archive::Rgssad->new('Game.rgssad');
    for my $entry ($rgssad->entries) {
      ...
    }

SUBROUTINES/METHODS ^

Constructor

new([$io])

Create an empty rgssad archive. If an additional argument is passed, call load to load the entries from it.

Load and Save

load($io)

Load entries from $io, which should be either a readable instance of IO::Handle or its subclasses or a valid filepath.

save($io)

Save the entries to $io, which should be either a writable instance of IO::Handle or its subclasses or a valid filepath.

Manipulate Entries

entries

Return all entries.

get($path)

Return all entries with specified path. In scalar context, just return the first one.

add($path => $data, ...)
add($entry, ...)

Add new entries like $entry or Archive::Rgssad::Entry->new($path, $data).

remove($path)
remove($entry)

If an entry is passed, remove the entries with the same path and data. Otherwise, remove all entries with specified path.

AUTHOR ^

Zejun Wu, <watashi at watashi.ws>

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Archive::Rgssad

You can also look for information at:

ACKNOWLEDGEMENTS ^

A special thanks to leexuany, who shared his discovery about the rgssad format and published the decryption algorithm.

LICENSE AND COPYRIGHT ^

Copyright 2012 Zejun Wu.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: