@2003scape/rsc-archiver 中文文档教程

发布于 4年前 浏览 19 项目主页 更新于 3年前

rsc-archiver

压缩和解压缩 runescape classic .jag/.mem 缓存文件。 这些文件 包含一个描述档案大小的专有标题,以及 每个单独的条目(文件)。 文件名存储在一个“哈希”中,所以它是 没有暴力破解就不可能恢复原件(除非他们在 ~5 个字符)。

该模块适用于浏览器和节点。

install

$ npm install @2003scape/rsc-archiver # -g for CLI program

cli usage

rsc-archiver <command>

Commands:
  rsc-archiver x <archive> <files..>  extract a file from an archive
                                                              [aliases: extract]
  rsc-archiver a <archive> <files..>  add files to an archive     [aliases: add]
  rsc-archiver d <archive> <files..>  remove files from an archive
                                                               [aliases: delete]
  rsc-archiver l <archive>            list hashes and file sizes in an archive
                                                                 [aliases: list]
  rsc-archiver h <name>               return the integer hash of a filename
                                      string                     [aliases: hash]

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

example

const fs = require('fs');
const { JagArchive } = require('./src');

let rawJag = fs.readFileSync('./data204/sounds1.mem');
let archive = new JagArchive();
archive.readArchive(rawJag);
console.log(`cache has ${archive.entries.size} files`);
fs.writeFileSync('death.pcm', archive.getEntry('death.pcm'));

const testArchive = new JagArchive();
testArchive.putEntry('test.txt', Buffer.from('test string'));
fs.writeFileSync('./data204/test.jag', testArchive.toArchive(true));

rawJag = fs.readFileSync('./data204/test.jag');
archive = new JagArchive();
archive.readArchive(rawJag);
console.log(`cache has ${archive.entries.size} files`);
console.log(archive.getEntry('test.txt').toString());

api

archive.entries

哈希图 -> 解压缩的文件缓冲区。

archive = new JagArchive()

创建一个新的 jag (de)compressor 实例。

archive.readArchive(buffer)

解压缩缓冲区并用其中的每个文件填充条目。

archive.hasEntry(name)

检查存档是否包含基于哈希或文件名的条目。

archive.getEntry(name)

根据名称或散列返回条目。

archive.putEntry(name, buffer)

将文件添加到存档缓冲区。

archive.removeEntry(name)

根据名称或散列删除条目。

archive.toArchive(individualCompress=true)

将条目压缩到 jagex 存档。 如果 individualCompress 为真,bzip 每个 单独归档。 否则,连接所有文件然后 bzip 而是那个结果。

license

版权所有 2020 2003Scape Team

该程序是免费软件:您可以重新分发它和/或修改它 GNU Affero 通用公共许可证的条款由 自由软件基金会,许可证的第 3 版,或(由您选择) 任何更高版本。

分发该程序是希望它有用,但没有任何 保修单; 甚至没有适销性或适用性的默示保证 特殊用途。 有关详细信息,请参阅 GNU Affero 通用公共许可证。

您应该已经收到 GNU Affero 通用公共许可证的副本 有了这个程序。 如果没有,请参阅 http://www.gnu.org/licenses/。

rsc-archiver

compress and decompress runescape classic .jag/.mem cache files. these files contain a proprietary header describing the size of the archive, and of each individual entry (file). filenames are stored with a "hash" so it's impossible to recover the originals without bruteforcing (unless they're under ~5 characters).

this module works in the browser and node.

install

$ npm install @2003scape/rsc-archiver # -g for CLI program

cli usage

rsc-archiver <command>

Commands:
  rsc-archiver x <archive> <files..>  extract a file from an archive
                                                              [aliases: extract]
  rsc-archiver a <archive> <files..>  add files to an archive     [aliases: add]
  rsc-archiver d <archive> <files..>  remove files from an archive
                                                               [aliases: delete]
  rsc-archiver l <archive>            list hashes and file sizes in an archive
                                                                 [aliases: list]
  rsc-archiver h <name>               return the integer hash of a filename
                                      string                     [aliases: hash]

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

example

const fs = require('fs');
const { JagArchive } = require('./src');

let rawJag = fs.readFileSync('./data204/sounds1.mem');
let archive = new JagArchive();
archive.readArchive(rawJag);
console.log(`cache has ${archive.entries.size} files`);
fs.writeFileSync('death.pcm', archive.getEntry('death.pcm'));

const testArchive = new JagArchive();
testArchive.putEntry('test.txt', Buffer.from('test string'));
fs.writeFileSync('./data204/test.jag', testArchive.toArchive(true));

rawJag = fs.readFileSync('./data204/test.jag');
archive = new JagArchive();
archive.readArchive(rawJag);
console.log(`cache has ${archive.entries.size} files`);
console.log(archive.getEntry('test.txt').toString());

api

archive.entries

Map of hashes -> decompressed file buffers.

archive = new JagArchive()

create a new jag (de)compressor instance.

archive.readArchive(buffer)

decompress buffer and populate entries with each file within.

archive.hasEntry(name)

check if archive contains entry based on hash or filename.

archive.getEntry(name)

return entry based on name or hash.

archive.putEntry(name, buffer)

add a file to the archive buffer.

archive.removeEntry(name)

remove entry based on name or hash.

archive.toArchive(individualCompress=true)

compress entries to a jagex archive. if individualCompress is true, bzip each file separately. otherwise, concatinate all of the files and then bzip that result instead.

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/.

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文