Skip to content

Commit

Permalink
Update plugin format docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Naamloos
Naamloos committed Dec 24, 2024
1 parent a681355 commit 410f67e
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions articles/plugin-format.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ The OBBY plugin format is inspired by the tModLoader mod format. It is a binary

### Binary Format Details
| Data Type | Description | Encoding Details |
|------------|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
| **String** | Encoded in ASCII, terminated with a null byte (`0x00`). Strings are used for various textual data within the plugin. | ASCII encoding, variable length, null-terminated. |
| **String** | Encoded in UTF-8, length-prefixed. Strings are used for various textual data within the plugin. | UTF-8 encoding, length-prefixed. |
| **Int32** | 4 bytes, little-endian order. This data type is used for numerical values such as sizes and counts. | 4 bytes, little-endian. |
| **Boolean**| 1 byte, `0x00` for false, `0x01` for true. Booleans are used for flags and binary states. | 1 byte (`0x00` for false, `0x01` for true). |
| **Byte array** | Raw binary data, length specified by context. Byte arrays are used for storing raw data such as file contents and hashes. | Variable length, raw binary data. |
Expand All @@ -20,15 +19,15 @@ The .obby file is structured in a specific layout to ensure that all necessary i

| Field | Description | Data Type | Binary Format |
|---------------------|-----------------------------------------------------------------------------|--------------------|-------------------------------------------------------------------------------|
| Magic Header | "OBBY" - Identifies the file as an Obsidian plugin package. | String | 4 bytes ASCII |
| Plugin API Version | The version of the plugin API that this plugin is compatible with. | String | Variable length, null-terminated |
| Magic Header | "OBBY" - Identifies the file as an Obsidian plugin package. | ASCII String | 4 bytes ASCII |
| Plugin API Version | The version of the plugin API that this plugin is compatible with. | String | Variable Length String |
| Header Size | Size of the header, varies depending on whether the plugin is signed. | Int32 | 4 bytes, little-endian |
| Plugin Assembly | The name of the plugin assembly. | String | Variable length, null-terminated |
| Plugin Version | The version of the plugin. | String | Variable length, null-terminated |
| Plugin Assembly | The name of the plugin assembly. | String | Variable Length String |
| Plugin Version | The version of the plugin. | String | Variable Length String |
| Entry Count | The number of entries (files) included in the package. | Int32 | 4 bytes, little-endian |
| Entry Headers | For each entry: Name, Original Length, Compressed Length. | List of structures | Each entry: Name (variable length, null-terminated), Original Length (Int32), Compressed Length (Int32) |
| Entry Headers | For each entry: Name, Original Length, Compressed Length. | List of structures | Each entry: Name (variable length string), Original Length (Int32), Compressed Length (Int32) |
| Entry Data | The actual data of each entry, possibly compressed. | Byte array | Variable length |
| Hash | SHA-384 hash of the data for integrity verification. | Byte array | 48 bytes |
| Signature Present | Boolean indicating if a signature is present. | Boolean | 1 byte (0 for false, 1 for true) |
| Signature | RSA signature of the hash, if signing is enabled. | Byte array | Variable length |
| Signature (**Optional**) | RSA signature of the hash, if signing is enabled. | Byte array | 512 bytes |
| Data Length | The length of the data section. | Int32 | 4 bytes, little-endian |

0 comments on commit 410f67e

Please sign in to comment.