{"id":49039151,"url":"https://github.com/rpg-maker-translation-tools/rvpacker-txt-rs-lib","last_synced_at":"2026-04-19T14:01:21.501Z","repository":{"id":265702064,"uuid":"896534267","full_name":"RPG-Maker-Translation-Tools/rvpacker-txt-rs-lib","owner":"RPG-Maker-Translation-Tools","description":"Library that allows to extract text from RPG Maker files.","archived":false,"fork":false,"pushed_at":"2026-04-10T11:26:15.000Z","size":579,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-10T13:25:22.003Z","etag":null,"topics":["extract","extract-text","library","rpg-maker","rpg-maker-mv","rpg-maker-mz","rpg-maker-vx","rpg-maker-vxace","rpg-maker-xp","rust","rust-crate","rust-library"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/rvpacker-txt-rs-lib","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RPG-Maker-Translation-Tools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-30T16:10:54.000Z","updated_at":"2026-04-10T11:26:22.000Z","dependencies_parsed_at":"2026-04-19T14:00:59.452Z","dependency_job_id":null,"html_url":"https://github.com/RPG-Maker-Translation-Tools/rvpacker-txt-rs-lib","commit_stats":null,"previous_names":["savannstm/rvpacker-txt-rs-lib"],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/RPG-Maker-Translation-Tools/rvpacker-txt-rs-lib","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RPG-Maker-Translation-Tools%2Frvpacker-txt-rs-lib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RPG-Maker-Translation-Tools%2Frvpacker-txt-rs-lib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RPG-Maker-Translation-Tools%2Frvpacker-txt-rs-lib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RPG-Maker-Translation-Tools%2Frvpacker-txt-rs-lib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RPG-Maker-Translation-Tools","download_url":"https://codeload.github.com/RPG-Maker-Translation-Tools/rvpacker-txt-rs-lib/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RPG-Maker-Translation-Tools%2Frvpacker-txt-rs-lib/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32009239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T20:23:30.271Z","status":"online","status_checked_at":"2026-04-19T02:00:07.110Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["extract","extract-text","library","rpg-maker","rpg-maker-mv","rpg-maker-mz","rpg-maker-vx","rpg-maker-vxace","rpg-maker-xp","rust","rust-crate","rust-library"],"created_at":"2026-04-19T14:00:44.590Z","updated_at":"2026-04-19T14:01:21.493Z","avatar_url":"https://github.com/RPG-Maker-Translation-Tools.png","language":"Rust","funding_links":["https://ko-fi.com/savannstm","https://www.patreon.com/cw/savannstm"],"categories":[],"sub_categories":[],"readme":"# rvpacker-txt-rs-lib\n\n`rvpacker-txt-rs-lib` that provides functions to extract the text from RPG Maker `.rxdata`, `.rvdata`, `.rvdata2` and `.json` files to `.txt` format for easy translation.\n\nIt also provides the `json` module to convert `.rxdata`, `.rvdata` and `.rvdata2` files to JSON and back.\n\nThis library is used in [RPGMTranslate GUI](https://github.com/rpg-maker-translation-tools/rpgmtranslate) and [rvpacker-txt-rs CLI](https://github.com/rpg-maker-translation-tools/rvpacker-txt-rs).\n\n## Installation\n\n`cargo add rvpacker-txt-rs-lib`\n\n## Features\n\nThis crate provides core structs and functions in `core` module, but also exports wrappers around those, like `Purger`, `Writer`, `Reader`.\n\n### `Reader`/`Writer`/`Purger`\n\nThese structs abstract over the `core` module and process files, handling all system calls.\n\n#### Example\n\n```rust no_run\nuse rvpacker_txt_rs_lib::{Reader, Writer, Purger, Error, FileFlags, EngineType};\n\nfn main() -\u003e Result\u003c(), Error\u003e {\n    let mut reader = Reader::new();\n    reader.set_files(FileFlags::Map | FileFlags::other());\n    reader.read(\"C:/Game/Data\", \"C:/Game/translation\", EngineType::VXAce)?;\n\n    let mut writer = Writer::new();\n    writer.set_files(FileFlags::Map | FileFlags::other());\n    writer.write(\"C:/Game/Data\", \"C:/Game/translation\", \"C:/Game/output\", EngineType::VXAce)?;\n\n    let mut purger = Purger::new();\n    purger.set_files(FileFlags::Map | FileFlags::other());\n    purger.purge(\"C:/Game/Data\", \"C:/Game/translation\", EngineType::VXAce)?;\n    Ok(())\n}\n```\n\n### `core` module\n\nThis module provides structs `Base`, `MapBase`, `OtherBase`, `SystemBase`, `PluginBase` and `ScriptBase`.\n\n#### Example\n\n```rust no_run\nuse rvpacker_txt_rs_lib::{core::{Base, MapBase}, Mode, EngineType, ReadMode};\nuse std::fs::read;\n\nfn main() -\u003e Result\u003c(), Box\u003cdyn std::error::Error\u003e\u003e {\n    let mut base = Base::new(Mode::Read(ReadMode::Default { force: true }), EngineType::VXAce);\n    let mut map_base = MapBase::new(\u0026mut base);\n\n    let mapinfos = read(\"C:/Game/Data/MapInfos.rvdata2\")?;\n    let map_file_content = read(\"C:/Game/Data/Map001.rvdata2\")?;\n    map_base.process(\"Map001.rvdata2\", \u0026map_file_content, \u0026mapinfos, None)?;\n\n    // To get the translation, you must use `translation` after processing all the maps.\n    let translation_data = map_base.translation();\n\n    Ok(())\n}\n```\n\n### `json` module\n\n`json` module provides `generate` and `write` functions to generate JSON representations of older engines' files and write them back respectively.\n\n#### Example\n\n```rust no_run\nuse rvpacker_txt_rs_lib::{json::{generate, write}, EngineType, Error};\n\nfn main() -\u003e Result\u003c(), Error\u003e {\n    generate(\"C:/Game/Data\", \"C:/Game/json\", false)?;\n    write(\"C:/Game/json\", \"C:/Game/json-output\", EngineType::VXAce)?;\n    Ok(())\n}\n```\n\n### Serialization/Deserialization\n\nAll public enums and structs in this crate are serializable with `serde`.\n\nFlat enums that contain only number variants are serialized with `#[serde(into = \"u8\", try_from = \"u8\")]` attribute, which converts enums to a single u8 integer, representing the variant. The same applies to `FileFlags` struct.\n\n## Support\n\n[Me](https://github.com/savannstm), the maintainer of this project, is a poor college student from Eastern Europe.\n\nIf you could, please consider supporting us through:\n\n- [Ko-fi](https://ko-fi.com/savannstm)\n- [Patreon](https://www.patreon.com/cw/savannstm)\n- [Boosty](https://boosty.to/mcdeimos)\n\nEven if you don't, it's fine. We'll continue to do as we right now.\n\n## License\n\nProject is licensed under WTFPL.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpg-maker-translation-tools%2Frvpacker-txt-rs-lib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frpg-maker-translation-tools%2Frvpacker-txt-rs-lib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpg-maker-translation-tools%2Frvpacker-txt-rs-lib/lists"}