mirror of
https://github.com/redstrate/Physis.git
synced 2025-04-19 17:36:50 +00:00
Partial map write support (#9)
This adds initial support for writing new/modified maps, which are made up of layer groups (LGB) and terrain (TERA). Neither one is really tested yet, but I started checking some simple examples and it seems to work.
This commit is contained in:
GitHub
parent
d2e724227b
commit
cdc39ad4b6
8 changed files with 455 additions and 297 deletions
|
|
@ -1,170 +0,0 @@
|
|||
Creative Commons Attribution-ShareAlike 4.0 International
|
||||
|
||||
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
|
||||
|
||||
Using Creative Commons Public Licenses
|
||||
|
||||
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
|
||||
|
||||
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
|
||||
|
||||
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described.
|
||||
|
||||
Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
|
||||
|
||||
Creative Commons Attribution-ShareAlike 4.0 International Public License
|
||||
|
||||
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
|
||||
|
||||
Section 1 – Definitions.
|
||||
|
||||
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
|
||||
|
||||
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
|
||||
|
||||
c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
|
||||
|
||||
d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
|
||||
|
||||
e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
|
||||
|
||||
f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
|
||||
|
||||
g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
|
||||
|
||||
h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
|
||||
|
||||
i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
|
||||
|
||||
k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
|
||||
|
||||
l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
|
||||
|
||||
m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
|
||||
|
||||
Section 2 – Scope.
|
||||
|
||||
a. License grant.
|
||||
|
||||
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
A. reproduce and Share the Licensed Material, in whole or in part; and
|
||||
|
||||
B. produce, reproduce, and Share Adapted Material.
|
||||
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
|
||||
|
||||
3. Term. The term of this Public License is specified in Section 6(a).
|
||||
|
||||
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
|
||||
|
||||
5. Downstream recipients.
|
||||
|
||||
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
|
||||
|
||||
B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
|
||||
|
||||
C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
|
||||
|
||||
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
b. Other rights.
|
||||
|
||||
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
|
||||
|
||||
2. Patent and trademark rights are not licensed under this Public License.
|
||||
|
||||
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
|
||||
|
||||
Section 3 – License Conditions.
|
||||
|
||||
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
|
||||
|
||||
a. Attribution.
|
||||
|
||||
1. If You Share the Licensed Material (including in modified form), You must:
|
||||
|
||||
A. retain the following if it is supplied by the Licensor with the Licensed Material:
|
||||
|
||||
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
|
||||
|
||||
ii. a copyright notice;
|
||||
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of warranties;
|
||||
|
||||
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
|
||||
|
||||
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
|
||||
|
||||
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
|
||||
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
|
||||
|
||||
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
|
||||
|
||||
b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
|
||||
|
||||
1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
|
||||
|
||||
2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
|
||||
|
||||
3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
|
||||
|
||||
Section 4 – Sui Generis Database Rights.
|
||||
|
||||
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
|
||||
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
|
||||
|
||||
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
|
||||
|
||||
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
|
||||
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
|
||||
|
||||
Section 5 – Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
|
||||
|
||||
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
|
||||
|
||||
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
|
||||
|
||||
Section 6 – Term and Termination.
|
||||
|
||||
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
|
||||
|
||||
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
|
||||
|
||||
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
|
||||
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
|
||||
|
||||
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
|
||||
|
||||
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
|
||||
|
||||
Section 7 – Other Terms and Conditions.
|
||||
|
||||
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
|
||||
|
||||
Section 8 – Interpretation.
|
||||
|
||||
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
|
||||
|
||||
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
|
||||
|
||||
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
|
||||
|
||||
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
|
||||
|
||||
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
# Architecture
|
||||
|
||||
This is a document going over my various design decisions I made
|
||||
with physis, to onboard future contributors and also point a light
|
||||
at possible mistakes and what we can do to solve them!
|
||||
|
||||
## Goals
|
||||
|
||||
I think it's important to go over what problems physis is set up to solve. It's meant to:
|
||||
|
||||
* Make patching easier for custom launchers
|
||||
* Users who want to write one-off tools that interact with the game data (like scrapers)
|
||||
* Modding tools that want to read and write game data in a safe way
|
||||
|
||||
Physis is all about game data, reading, writing and modifying it. However, it's keen to
|
||||
keep it _safe_ and prevent invalid data from being written, and if there is invalid data
|
||||
being read - to make it obvious to the developer. So there is a high-level representation
|
||||
of a file format, which is built on top of our custom parsers:
|
||||
|
||||
```rust
|
||||
#[derive(Debug)]
|
||||
pub struct IndexEntry {
|
||||
pub hash: u64,
|
||||
pub data_file_id: u8,
|
||||
pub offset: u32,
|
||||
}
|
||||
|
||||
#[binrw]
|
||||
#[br(little)]
|
||||
pub struct IndexFile {
|
||||
sqpack_header: SqPackHeader,
|
||||
|
||||
#[br(seek_before = SeekFrom::Start(sqpack_header.size.into()))]
|
||||
index_header: SqPackIndexHeader,
|
||||
|
||||
#[br(seek_before = SeekFrom::Start(index_header.index_data_offset.into()))]
|
||||
#[br(count = index_header.index_data_size / 16)]
|
||||
pub entries: Vec<IndexHashTableEntry>,
|
||||
}
|
||||
```
|
||||
|
||||
Here's a section of `src/index.rs` that showcases an example of this methodology, headers and other auto-generated data
|
||||
is hidden by the developer (as there is very little to worry about there anyway) and they only need access to modifying and
|
||||
reading entries. There is still work to be done to improve upon this, but this is the general idea when writing for
|
||||
game format parsing.
|
||||
|
||||
## Top-level Architecture
|
||||
|
||||
There is a bunch of methods to crack open your dat files, but the best way is to `GameData` and `BootData`. These two
|
||||
structures help parse and ensure boot and game data is valid.
|
||||
|
||||
There is helper methods in `GameData` such as `extract(path)` and `exists(path)` which are wrappers around other public
|
||||
APIs, but make it easier for developers to get started.
|
||||
|
||||
When parsing game data, you'll notice many formats only accept a memory buffer, which is just a `Vec<u8>`. These are
|
||||
passed as references, and are purely non-owning. The purpose of this is because some files are not backed by a file on disk,
|
||||
but instead are extracted and processed entirely in memory.
|
||||
BIN
resources/tests/empty_planlive.lgb
Normal file
BIN
resources/tests/empty_planlive.lgb
Normal file
Binary file not shown.
|
|
@ -63,14 +63,13 @@ pub(crate) fn string_from_offset(start: u64) -> BinResult<String> {
|
|||
let old_pos = reader.stream_position()?;
|
||||
|
||||
reader.seek(SeekFrom::Start(start + offset as u64))?;
|
||||
reader.seek(SeekFrom::Start(start))?;
|
||||
let mut next_char = reader.read_le::<u8>().unwrap() as char;
|
||||
while next_char != '\0' {
|
||||
string.push(next_char);
|
||||
next_char = reader.read_le::<u8>().unwrap() as char;
|
||||
}
|
||||
|
||||
reader.seek(SeekFrom::Start(old_pos))?;
|
||||
|
||||
Ok(string)
|
||||
}
|
||||
|
||||
|
|
|
|||
482
src/layer/mod.rs
482
src/layer/mod.rs
|
|
@ -1,12 +1,14 @@
|
|||
// SPDX-FileCopyrightText: 2024 Joshua Goins <josh@redstrate.com>
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
use std::io::{Cursor, Read, Seek, SeekFrom};
|
||||
use std::io::{Cursor, Read, Seek, SeekFrom, Write};
|
||||
|
||||
use crate::ByteSpan;
|
||||
use crate::common_file_operations::{read_bool_from, string_from_offset};
|
||||
use binrw::binrw;
|
||||
use binrw::{BinRead, BinReaderExt, binread};
|
||||
use crate::common_file_operations::{
|
||||
read_bool_from, string_from_offset, write_bool_as, write_string,
|
||||
};
|
||||
use crate::{ByteBuffer, ByteSpan};
|
||||
use binrw::{BinRead, BinReaderExt, BinWrite, binread};
|
||||
use binrw::{Endian, Error, binrw};
|
||||
|
||||
mod aetheryte;
|
||||
pub use aetheryte::AetheryteInstanceObject;
|
||||
|
|
@ -64,6 +66,149 @@ pub use trigger_box::TriggerBoxShape;
|
|||
// From https://github.com/NotAdam/Lumina/tree/40dab50183eb7ddc28344378baccc2d63ae71d35/src/Lumina/Data/Parsing/Layer
|
||||
// Also see https://github.com/aers/FFXIVClientStructs/blob/6b62122cae38bfbc016bf697bef75f80f37abac1/FFXIVClientStructs/FFXIV/Client/LayoutEngine/ILayoutInstance.cs
|
||||
|
||||
/// "LGB1"
|
||||
const LGB1_ID: u32 = u32::from_le_bytes(*b"LGB1");
|
||||
/// "LGP1"
|
||||
const LGP1_ID: u32 = u32::from_le_bytes(*b"LGP1");
|
||||
|
||||
/// A string that exists in a different location in the file, usually a heap with a bunch of other strings.
|
||||
#[binrw]
|
||||
#[br(import(string_heap: &StringHeap), stream = r)]
|
||||
#[bw(import(string_heap: &mut StringHeap))]
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct HeapString {
|
||||
#[br(temp)]
|
||||
// TODO: this cast is stupid
|
||||
#[bw(calc = string_heap.get_free_offset_string(value) as u32)]
|
||||
pub offset: u32,
|
||||
#[br(calc = string_heap.read_string(r, offset,))]
|
||||
#[bw(ignore)]
|
||||
pub value: String,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct StringHeap {
|
||||
pub pos: u64,
|
||||
pub bytes: Vec<u8>,
|
||||
pub free_pos: u64,
|
||||
}
|
||||
|
||||
impl StringHeap {
|
||||
pub fn from(pos: u64) -> Self {
|
||||
Self {
|
||||
pos,
|
||||
bytes: Vec::new(),
|
||||
free_pos: 0, // unused, so it doesn't matter
|
||||
}
|
||||
}
|
||||
|
||||
pub fn get_free_offset_args<T>(&mut self, obj: &T) -> i32
|
||||
where
|
||||
T: for<'a> BinWrite<Args<'a> = (&'a mut StringHeap,)> + std::fmt::Debug,
|
||||
{
|
||||
// figure out size of it
|
||||
let mut buffer = ByteBuffer::new();
|
||||
{
|
||||
let mut cursor = Cursor::new(&mut buffer);
|
||||
obj.write_le_args(&mut cursor, (self,)).unwrap();
|
||||
}
|
||||
|
||||
self.bytes.append(&mut buffer);
|
||||
|
||||
let old_pos = self.free_pos;
|
||||
self.free_pos += buffer.len() as u64;
|
||||
|
||||
old_pos as i32
|
||||
}
|
||||
|
||||
pub fn get_free_offset<T>(&mut self, obj: &T) -> i32
|
||||
where
|
||||
T: for<'a> BinWrite<Args<'a> = ()> + std::fmt::Debug,
|
||||
{
|
||||
// figure out size of it
|
||||
let mut buffer = ByteBuffer::new();
|
||||
{
|
||||
let mut cursor = Cursor::new(&mut buffer);
|
||||
obj.write_le(&mut cursor).unwrap();
|
||||
}
|
||||
|
||||
self.bytes.append(&mut buffer);
|
||||
|
||||
let old_pos = self.free_pos;
|
||||
self.free_pos += buffer.len() as u64;
|
||||
|
||||
old_pos as i32
|
||||
}
|
||||
|
||||
pub fn get_free_offset_string(&mut self, str: &String) -> i32 {
|
||||
let bytes = write_string(str);
|
||||
self.get_free_offset(&bytes)
|
||||
}
|
||||
|
||||
pub fn read<R, T>(&self, reader: &mut R, offset: i32) -> T
|
||||
where
|
||||
R: Read + Seek,
|
||||
T: for<'a> BinRead<Args<'a> = ()>,
|
||||
{
|
||||
let old_pos = reader.stream_position().unwrap();
|
||||
reader
|
||||
.seek(SeekFrom::Start((self.pos as i32 + offset) as u64))
|
||||
.unwrap();
|
||||
let obj = reader.read_le::<T>().unwrap();
|
||||
reader.seek(SeekFrom::Start(old_pos)).unwrap();
|
||||
obj
|
||||
}
|
||||
|
||||
pub fn read_args<R, T>(&self, reader: &mut R, offset: i32) -> T
|
||||
where
|
||||
R: Read + Seek,
|
||||
T: for<'a> BinRead<Args<'a> = (&'a StringHeap,)>,
|
||||
{
|
||||
let old_pos = reader.stream_position().unwrap();
|
||||
reader
|
||||
.seek(SeekFrom::Start((self.pos as i32 + offset) as u64))
|
||||
.unwrap();
|
||||
let obj = reader.read_le_args::<T>((self,)).unwrap();
|
||||
reader.seek(SeekFrom::Start(old_pos)).unwrap();
|
||||
obj
|
||||
}
|
||||
|
||||
pub fn read_string<R>(&self, reader: &mut R, offset: u32) -> String
|
||||
where
|
||||
R: Read + Seek,
|
||||
{
|
||||
let offset = self.pos + offset as u64;
|
||||
|
||||
let mut string = String::new();
|
||||
|
||||
let old_pos = reader.stream_position().unwrap();
|
||||
|
||||
reader.seek(SeekFrom::Start(offset)).unwrap();
|
||||
let mut next_char = reader.read_le::<u8>().unwrap() as char;
|
||||
while next_char != '\0' {
|
||||
string.push(next_char);
|
||||
next_char = reader.read_le::<u8>().unwrap() as char;
|
||||
}
|
||||
reader.seek(SeekFrom::Start(old_pos)).unwrap();
|
||||
string
|
||||
}
|
||||
}
|
||||
|
||||
impl BinWrite for StringHeap {
|
||||
type Args<'a> = ();
|
||||
|
||||
fn write_options<W: Write + Seek>(
|
||||
&self,
|
||||
writer: &mut W,
|
||||
endian: Endian,
|
||||
(): Self::Args<'_>,
|
||||
) -> Result<(), Error> {
|
||||
self.bytes.write_options(writer, endian, ())?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: convert these all to magic
|
||||
#[binrw]
|
||||
#[brw(repr = i32)]
|
||||
|
|
@ -337,51 +482,78 @@ enum LayerSetReferencedType {
|
|||
Undetermined = 0x3,
|
||||
}
|
||||
|
||||
#[binread]
|
||||
#[binrw]
|
||||
#[derive(Debug)]
|
||||
#[br(little)]
|
||||
#[br(import(start: u64))]
|
||||
#[brw(little)]
|
||||
#[br(import(data_heap: &StringHeap, string_heap: &StringHeap), stream = r)]
|
||||
#[bw(import(data_heap: &mut StringHeap, string_heap: &mut StringHeap))]
|
||||
#[allow(dead_code)] // most of the fields are unused at the moment
|
||||
struct LayerHeader {
|
||||
layer_id: u32,
|
||||
pub layer_id: u32,
|
||||
|
||||
#[br(parse_with = string_from_offset, args(start))]
|
||||
name: String,
|
||||
#[brw(args(string_heap))]
|
||||
pub name: HeapString,
|
||||
|
||||
instance_object_offset: i32,
|
||||
instance_object_count: i32,
|
||||
pub instance_object_offset: i32,
|
||||
pub instance_object_count: i32,
|
||||
|
||||
#[br(map = read_bool_from::<u8>)]
|
||||
tool_mode_visible: bool,
|
||||
#[bw(map = write_bool_as::<u8>)]
|
||||
pub tool_mode_visible: bool,
|
||||
#[br(map = read_bool_from::<u8>)]
|
||||
tool_mode_read_only: bool,
|
||||
#[bw(map = write_bool_as::<u8>)]
|
||||
pub tool_mode_read_only: bool,
|
||||
|
||||
#[br(map = read_bool_from::<u8>)]
|
||||
is_bush_layer: bool,
|
||||
#[bw(map = write_bool_as::<u8>)]
|
||||
pub is_bush_layer: bool,
|
||||
#[br(map = read_bool_from::<u8>)]
|
||||
ps3_visible: bool,
|
||||
layer_set_referenced_list_offset: i32,
|
||||
festival_id: u16,
|
||||
festival_phase_id: u16,
|
||||
is_temporary: u8,
|
||||
is_housing: u8,
|
||||
version_mask: u16,
|
||||
#[bw(map = write_bool_as::<u8>)]
|
||||
pub ps3_visible: bool,
|
||||
#[br(temp)]
|
||||
#[bw(calc = data_heap.get_free_offset_args(&layer_set_referenced_list))]
|
||||
pub layer_set_referenced_list_offset: i32,
|
||||
#[br(calc = data_heap.read_args(r, layer_set_referenced_list_offset))]
|
||||
#[bw(ignore)]
|
||||
pub layer_set_referenced_list: LayerSetReferencedList,
|
||||
pub festival_id: u16,
|
||||
pub festival_phase_id: u16,
|
||||
pub is_temporary: u8,
|
||||
pub is_housing: u8,
|
||||
pub version_mask: u16,
|
||||
|
||||
#[br(pad_before = 4)]
|
||||
ob_set_referenced_list: i32,
|
||||
ob_set_referenced_list_count: i32,
|
||||
ob_set_enable_referenced_list: i32,
|
||||
ob_set_enable_referenced_list_count: i32,
|
||||
#[brw(pad_before = 4)]
|
||||
pub ob_set_referenced_list: i32,
|
||||
pub ob_set_referenced_list_count: i32,
|
||||
pub ob_set_enable_referenced_list: i32,
|
||||
pub ob_set_enable_referenced_list_count: i32,
|
||||
}
|
||||
|
||||
#[binread]
|
||||
#[binrw]
|
||||
#[derive(Debug)]
|
||||
#[br(little)]
|
||||
#[brw(little)]
|
||||
#[allow(dead_code)] // most of the fields are unused at the moment
|
||||
struct LayerSetReferenced {
|
||||
layer_set_id: u32,
|
||||
}
|
||||
|
||||
#[binrw]
|
||||
#[derive(Debug)]
|
||||
#[brw(little)]
|
||||
#[br(import(data_heap: &StringHeap), stream = r)]
|
||||
#[bw(import(data_heap: &mut StringHeap))]
|
||||
#[allow(dead_code)] // most of the fields are unused at the moment
|
||||
struct LayerSetReferencedList {
|
||||
referenced_type: LayerSetReferencedType,
|
||||
layer_sets: i32,
|
||||
#[br(temp)]
|
||||
#[bw(calc = data_heap.get_free_offset(&layer_sets))]
|
||||
layer_set_offset: i32,
|
||||
#[bw(calc = layer_sets.len() as i32)]
|
||||
layer_set_count: i32,
|
||||
|
||||
#[br(count = layer_set_count)]
|
||||
#[bw(ignore)]
|
||||
layer_sets: Vec<LayerSetReferenced>,
|
||||
}
|
||||
|
||||
#[binread]
|
||||
|
|
@ -408,31 +580,36 @@ struct OBSetEnableReferenced {
|
|||
padding: [u8; 2],
|
||||
}
|
||||
|
||||
#[binread]
|
||||
#[binrw]
|
||||
#[derive(Debug)]
|
||||
#[br(little)]
|
||||
#[brw(little)]
|
||||
#[allow(dead_code)] // most of the fields are unused at the moment
|
||||
struct LgbHeader {
|
||||
#[br(count = 4)]
|
||||
file_id: Vec<u8>,
|
||||
// Example: "LGB1"
|
||||
file_id: u32,
|
||||
// File size *including* this header
|
||||
file_size: i32,
|
||||
total_chunk_count: i32,
|
||||
}
|
||||
|
||||
#[binread]
|
||||
#[binrw]
|
||||
#[derive(Debug)]
|
||||
#[br(little)]
|
||||
#[br(import(string_heap: &StringHeap), stream = r)]
|
||||
#[bw(import(string_heap: &mut StringHeap))]
|
||||
#[brw(little)]
|
||||
#[allow(dead_code)] // most of the fields are unused at the moment
|
||||
struct LayerChunk {
|
||||
#[br(count = 4)]
|
||||
chunk_id: Vec<u8>,
|
||||
struct LayerChunkHeader {
|
||||
chunk_id: u32,
|
||||
chunk_size: i32,
|
||||
layer_group_id: i32,
|
||||
name_offset: u32,
|
||||
#[brw(args(string_heap))]
|
||||
pub name: HeapString,
|
||||
layer_offset: i32,
|
||||
layer_count: i32,
|
||||
}
|
||||
|
||||
const LAYER_CHUNK_HEADER_SIZE: usize = 24;
|
||||
|
||||
#[binread]
|
||||
#[derive(Debug)]
|
||||
#[br(little)]
|
||||
|
|
@ -450,16 +627,25 @@ pub struct InstanceObject {
|
|||
|
||||
#[derive(Debug)]
|
||||
pub struct Layer {
|
||||
pub id: u32,
|
||||
pub name: String,
|
||||
pub header: LayerHeader,
|
||||
pub objects: Vec<InstanceObject>,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct LayerGroup {
|
||||
pub struct LayerChunk {
|
||||
// Example: "LGP1"
|
||||
pub chunk_id: u32,
|
||||
pub layer_group_id: i32,
|
||||
pub name: String,
|
||||
pub layers: Vec<Layer>,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct LayerGroup {
|
||||
pub file_id: u32,
|
||||
pub chunks: Vec<LayerChunk>,
|
||||
}
|
||||
|
||||
impl LayerGroup {
|
||||
/// Reads an existing PBD file
|
||||
pub fn from_existing(buffer: ByteSpan) -> Option<LayerGroup> {
|
||||
|
|
@ -470,7 +656,11 @@ impl LayerGroup {
|
|||
return None;
|
||||
}
|
||||
|
||||
let chunk_header = LayerChunk::read(&mut cursor).unwrap();
|
||||
// yes, for some reason it begins at 8 bytes in?!?!
|
||||
let chunk_string_heap = StringHeap::from(cursor.position() + 8);
|
||||
|
||||
let chunk_header =
|
||||
LayerChunkHeader::read_le_args(&mut cursor, (&chunk_string_heap,)).unwrap();
|
||||
|
||||
if chunk_header.chunk_size <= 0 {
|
||||
return None;
|
||||
|
|
@ -492,7 +682,11 @@ impl LayerGroup {
|
|||
|
||||
let old_pos = cursor.position();
|
||||
|
||||
let header = LayerHeader::read_le_args(&mut cursor, (old_pos,)).unwrap();
|
||||
let string_heap = StringHeap::from(old_pos);
|
||||
let data_heap = StringHeap::from(old_pos);
|
||||
|
||||
let header =
|
||||
LayerHeader::read_le_args(&mut cursor, (&data_heap, &string_heap)).unwrap();
|
||||
|
||||
let mut objects = Vec::new();
|
||||
// read instance objects
|
||||
|
|
@ -517,17 +711,6 @@ impl LayerGroup {
|
|||
}
|
||||
}
|
||||
|
||||
// read layer set referenced list
|
||||
{
|
||||
// NOTE: this casting is INTENTIONALLY like this, layer_set_referenced_list_offset CAN be negative!
|
||||
cursor
|
||||
.seek(SeekFrom::Start(
|
||||
(old_pos as i32 + header.layer_set_referenced_list_offset) as u64,
|
||||
))
|
||||
.unwrap();
|
||||
let ref_list = LayerSetReferencedList::read(&mut cursor).unwrap();
|
||||
}
|
||||
|
||||
// read ob set referenced
|
||||
{
|
||||
cursor
|
||||
|
|
@ -552,14 +735,150 @@ impl LayerGroup {
|
|||
}
|
||||
}
|
||||
|
||||
layers.push(Layer {
|
||||
id: header.layer_id,
|
||||
name: header.name,
|
||||
objects,
|
||||
});
|
||||
layers.push(Layer { header, objects });
|
||||
}
|
||||
|
||||
Some(LayerGroup { layers })
|
||||
let layer_chunk = LayerChunk {
|
||||
chunk_id: chunk_header.chunk_id,
|
||||
layer_group_id: chunk_header.layer_group_id,
|
||||
name: chunk_header.name.value,
|
||||
layers,
|
||||
};
|
||||
|
||||
Some(LayerGroup {
|
||||
file_id: file_header.file_id,
|
||||
chunks: vec![layer_chunk],
|
||||
})
|
||||
}
|
||||
|
||||
pub fn write_to_buffer(&self) -> Option<ByteBuffer> {
|
||||
let mut buffer = ByteBuffer::new();
|
||||
|
||||
{
|
||||
let mut cursor = Cursor::new(&mut buffer);
|
||||
|
||||
// skip header, will be writing it later
|
||||
cursor
|
||||
.seek(SeekFrom::Start(std::mem::size_of::<LgbHeader>() as u64))
|
||||
.unwrap();
|
||||
|
||||
// base offset for deferred data
|
||||
let mut data_base = cursor.stream_position().unwrap();
|
||||
|
||||
let mut chunk_data_heap = StringHeap {
|
||||
pos: data_base + 4,
|
||||
bytes: Vec::new(),
|
||||
free_pos: data_base + 4,
|
||||
};
|
||||
|
||||
let mut chunk_string_heap = StringHeap {
|
||||
pos: data_base + 4,
|
||||
bytes: Vec::new(),
|
||||
free_pos: data_base + 4,
|
||||
};
|
||||
|
||||
// we will write this later, when we have a working string heap
|
||||
let layer_chunk_header_pos = cursor.stream_position().unwrap();
|
||||
cursor
|
||||
.seek(SeekFrom::Current(LAYER_CHUNK_HEADER_SIZE as i64))
|
||||
.unwrap();
|
||||
|
||||
// skip offsets for now, they will be written later
|
||||
let offset_pos = cursor.position();
|
||||
cursor
|
||||
.seek(SeekFrom::Current(
|
||||
(std::mem::size_of::<i32>() * self.chunks[0].layers.len()) as i64,
|
||||
))
|
||||
.ok()?;
|
||||
|
||||
let mut offsets: Vec<i32> = Vec::new();
|
||||
|
||||
let layer_data_offset = cursor.position();
|
||||
|
||||
// first pass: write layers, we want to get a correct *chunk_data_heap*
|
||||
for layer in &self.chunks[0].layers {
|
||||
// set offset
|
||||
// this is also used to reference positions inside this layer
|
||||
let layer_offset = cursor.position() as i32;
|
||||
offsets.push(layer_offset);
|
||||
|
||||
layer
|
||||
.header
|
||||
.write_le_args(&mut cursor, (&mut chunk_data_heap, &mut chunk_string_heap))
|
||||
.ok()?;
|
||||
}
|
||||
|
||||
// make sure the heaps are at the end of the layer data
|
||||
data_base += cursor.stream_position().unwrap() - layer_data_offset;
|
||||
|
||||
// second pass: write layers again, we want to get a correct *chunk_string_heap* now that we know of the size of chunk_data_heap
|
||||
chunk_string_heap = StringHeap {
|
||||
pos: data_base + 4 + chunk_data_heap.bytes.len() as u64,
|
||||
bytes: Vec::new(),
|
||||
free_pos: data_base + 4 + chunk_data_heap.bytes.len() as u64,
|
||||
};
|
||||
chunk_data_heap = StringHeap {
|
||||
pos: data_base + 4,
|
||||
bytes: Vec::new(),
|
||||
free_pos: data_base + 4,
|
||||
};
|
||||
|
||||
// write header now, because it has a string
|
||||
cursor
|
||||
.seek(SeekFrom::Start(layer_chunk_header_pos))
|
||||
.unwrap();
|
||||
// TODO: support multiple layer chunks
|
||||
let layer_chunk = LayerChunkHeader {
|
||||
chunk_id: self.chunks[0].chunk_id,
|
||||
chunk_size: 24, // double lol
|
||||
layer_group_id: self.chunks[0].layer_group_id,
|
||||
name: HeapString {
|
||||
value: self.chunks[0].name.clone(),
|
||||
},
|
||||
layer_offset: 16, // lol
|
||||
layer_count: self.chunks[0].layers.len() as i32,
|
||||
};
|
||||
layer_chunk
|
||||
.write_le_args(&mut cursor, (&mut chunk_string_heap,))
|
||||
.ok()?;
|
||||
|
||||
// now write the layer data for the final time
|
||||
cursor.seek(SeekFrom::Start(layer_data_offset)).unwrap();
|
||||
for layer in &self.chunks[0].layers {
|
||||
layer
|
||||
.header
|
||||
.write_le_args(&mut cursor, (&mut chunk_data_heap, &mut chunk_string_heap))
|
||||
.ok()?;
|
||||
}
|
||||
|
||||
// write the heaps
|
||||
chunk_data_heap.write_le(&mut cursor).ok()?;
|
||||
chunk_string_heap.write_le(&mut cursor).ok()?;
|
||||
|
||||
// write offsets
|
||||
assert_eq!(offsets.len(), self.chunks[0].layers.len());
|
||||
cursor.seek(SeekFrom::Start(offset_pos)).ok()?;
|
||||
for offset in offsets {
|
||||
offset.write_le(&mut cursor).ok()?;
|
||||
}
|
||||
}
|
||||
|
||||
let file_size = buffer.len() as i32;
|
||||
|
||||
{
|
||||
let mut cursor = Cursor::new(&mut buffer);
|
||||
|
||||
// write the header, now that we now the file size
|
||||
cursor.seek(SeekFrom::Start(0)).ok()?;
|
||||
let lgb_header = LgbHeader {
|
||||
file_id: self.file_id,
|
||||
file_size,
|
||||
total_chunk_count: self.chunks.len() as i32,
|
||||
};
|
||||
lgb_header.write_le(&mut cursor).ok()?;
|
||||
}
|
||||
|
||||
Some(buffer)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -579,4 +898,41 @@ mod tests {
|
|||
// Feeding it invalid data should not panic
|
||||
LayerGroup::from_existing(&read(d).unwrap());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn read_empty_planlive() {
|
||||
let mut d = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
|
||||
d.push("resources/tests");
|
||||
d.push("empty_planlive.lgb");
|
||||
|
||||
let lgb = LayerGroup::from_existing(&read(d).unwrap()).unwrap();
|
||||
assert_eq!(lgb.file_id, LGB1_ID);
|
||||
assert_eq!(lgb.chunks.len(), 1);
|
||||
|
||||
let chunk = &lgb.chunks[0];
|
||||
assert_eq!(chunk.chunk_id, LGP1_ID);
|
||||
assert_eq!(chunk.layer_group_id, 261);
|
||||
assert_eq!(chunk.name, "PlanLive".to_string());
|
||||
assert!(chunk.layers.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn write_empty_planlive() {
|
||||
let mut d = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
|
||||
d.push("resources/tests");
|
||||
d.push("empty_planlive.lgb");
|
||||
|
||||
let good_lgb_bytes = read(d).unwrap();
|
||||
|
||||
let lgb = LayerGroup {
|
||||
file_id: LGB1_ID,
|
||||
chunks: vec![LayerChunk {
|
||||
chunk_id: LGP1_ID,
|
||||
layer_group_id: 261,
|
||||
name: "PlanLive".to_string(),
|
||||
layers: Vec::new(),
|
||||
}],
|
||||
};
|
||||
assert_eq!(lgb.write_to_buffer().unwrap(), good_lgb_bytes);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
// SPDX-FileCopyrightText: 2025 Joshua Goins <josh@redstrate.com>
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
use binrw::{binread, binrw};
|
||||
use binrw::binread;
|
||||
|
||||
use super::common::RelativePositions;
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
// SPDX-FileCopyrightText: 2025 Joshua Goins <josh@redstrate.com>
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
use binrw::{binread, binrw};
|
||||
use binrw::binread;
|
||||
|
||||
use super::common::RelativePositions;
|
||||
|
||||
|
|
|
|||
36
src/tera.rs
36
src/tera.rs
|
|
@ -3,8 +3,10 @@
|
|||
|
||||
use std::io::Cursor;
|
||||
|
||||
use crate::ByteBuffer;
|
||||
use crate::ByteSpan;
|
||||
use binrw::BinRead;
|
||||
use binrw::BinWrite;
|
||||
use binrw::binrw;
|
||||
|
||||
#[binrw]
|
||||
|
|
@ -19,6 +21,7 @@ struct PlatePosition {
|
|||
#[derive(Debug)]
|
||||
#[brw(little)]
|
||||
struct TerrainHeader {
|
||||
// Example: 0x1000003
|
||||
version: u32,
|
||||
plate_count: u32,
|
||||
plate_size: u32,
|
||||
|
|
@ -26,9 +29,7 @@ struct TerrainHeader {
|
|||
|
||||
unknown: f32,
|
||||
|
||||
#[br(count = 32)]
|
||||
padding: Vec<u8>,
|
||||
|
||||
#[brw(pad_before = 32)]
|
||||
#[br(count = plate_count)]
|
||||
positions: Vec<PlatePosition>,
|
||||
}
|
||||
|
|
@ -64,6 +65,35 @@ impl Terrain {
|
|||
|
||||
Some(Terrain { plates })
|
||||
}
|
||||
|
||||
pub fn write_to_buffer(&self) -> Option<ByteBuffer> {
|
||||
let mut buffer = ByteBuffer::new();
|
||||
|
||||
{
|
||||
let mut cursor = Cursor::new(&mut buffer);
|
||||
|
||||
let plate_size = 128;
|
||||
|
||||
let header = TerrainHeader {
|
||||
version: 0x1000003,
|
||||
plate_count: self.plates.len() as u32,
|
||||
plate_size,
|
||||
clip_distance: 0.0, // TODO: make configurable
|
||||
unknown: 1.0, // TODO: what is this
|
||||
positions: self
|
||||
.plates
|
||||
.iter()
|
||||
.map(|model| PlatePosition {
|
||||
x: ((model.position.0 / plate_size as f32) - 0.5) as i16,
|
||||
y: ((model.position.1 / plate_size as f32) - 0.5) as i16,
|
||||
})
|
||||
.collect(),
|
||||
};
|
||||
header.write_le(&mut cursor).ok()?;
|
||||
}
|
||||
|
||||
Some(buffer)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue