lcf-rs

A bidirectional parser for the lcf file format used by RPG Maker 2000 games.

Rust port of the C++ library EasyRPG/liblcf, which is licensed under MIT.

JavaScript bindings are available with lcf-js.

lib.rs:

Lcf-rs

Lcf is the file format used by the RPG Maker 2000/2003 game engine.

Each of the different file types is in a module with its extension as the name:

• crate::ldb::LcfDataBase e.g. RPG_RT.ldb
• crate::lmt::LcfMapTree e.g. RPG_RT.lmt
• crate::lmu::LcfMapUnit e.g. MapXXXX.lmu
• crate::lsd::LcfSaveData e.g. SaveXX.lsd

The crate::Lcf enum contains all of the above 4 types as variants and can be used if the exact one is not known ahead of time.

The above 5 types are wrappers around their corresponding structs in the crate::raw module:

• crate::raw::RawLcf
• crate::raw::ldb::RawLcfDataBase
• crate::raw::lmt::RawLcfMapTree
• crate::raw::lmu::RawLcfMapUnit
• crate::raw::lsd::RawLcfSaveData

All of the raw structs implement binrw::BinRead and binrw::BinWrite, as well as From and TryInto for their wrapper.

Example

use lcf::ConvertExt as _; // Bring the conversion trait into scope for wrapper formats.

let bytes = std::fs::read("RPG_RT.ldb").expect("file exists");
let mut reader = std::io::Cursor::new(bytes);
let database = lcf::Lcf::read(&mut reader).expect("valid lcf file");
assert!(matches!(database, lcf::Lcf::DataBase(_)))

Disclaimers

• This crate is currently incomplete, some fields are left as uninterpreted byte arrays.
• The raw structs can complete round trips successfully but the managed structs lose information.
• RPG Maker 2003 features are entirely unsupported.
• Save data is completely unimplemented.

JavaScript bindings are available with lcf-js.

Additionally see lcf-explorer and d2k for full examples.