GBlorbLib

From IFWiki

GBlorbLib
Utility
Gblorb format manipulation library/utilities
GBlorbLib-cover.jpg
Links Home page Download
Developer Roberto Ceccarelli
Format Glulx
Interaction style
Systems Windows, macOS, Linux
System details
Latest version r250601 / 1 Jun 2025
Status
Implements Blorb
Uses .net 8.0


License AGPL 3.0
Notes
Browse the software database
Edit this infobox

The library GBlorbLib, and the accompanying tools GBlorbExtractor and GBlorbEd, are for examining/manipulating (g)blorb files. They are implemented in .NET.

GBlorbExtractor

GBlorbExtractor is a command-line utility for extracting and listing resources from GBlorb files, which are archives used in interactive fiction (IF) games.

The tool allows users to view the contents of a GBlorb file or extract all embedded resources (such as images, sounds, and metadata) to a specified directory.

This is the command line syntax:

Casasoft GBlorbExtractor v1.0
(c) 2025 Roberto Ceccarelli - Casasoft

Usage: GBlorbExtractor [OPTIONS] FILES
Extracts the resources from a GBlorb file.

Options:
  -q, --quiet                Suppress banner print
  -h, -?, --help             Show this help
  -l, --list                 List the content of the archive
  -x, --extract=VALUE        Extract the resources in the specified dir

GBlorbEd

GBlorbEd is a command-line editor for GBlorb files, which are used to package resources for interactive fiction (IF) games.

This tool allows users to modify metadata such as author, copyright, annotations, and frontispiece image references within a GBlorb file.

It supports reading an existing GBlorb file, updating its components, and writing the changes to a new output file.

This is the command line syntax:

Casasoft GBlorb command line editor v1.0
(c) 2025 Roberto Ceccarelli - Casasoft

Usage: GBlorbEd [OPTIONS] FILE -o OUTFILE
Edits components of a GBlorb file.

Options:
  -q, --quiet                Suppress banner print
  -h, -?, --help             Show this help
  -o, --output=VALUE         Output filename
  -f, --frontispice=VALUE    Frontispice resource number
  -a, --author=VALUE         Author name
  -c, --copyright=VALUE      Copyright notice
  -r, --remarks, --annotations=VALUE
                             Annotations

GBlorbLib

GBlorbLib is a .NET library for working with the GBlorb file format, which is used to package resources for interactive fiction (IF) games. It provides functionality to read, manipulate, and write GBlorb files, including handling headers, resource indices, and chunks.

Features

  • Parse GBlorb files to extract headers, resource indices, and chunks.
  • Export individual chunks to files.
  • Add or update optional text chunks (e.g., author, copyright, annotations).
  • Write modified GBlorb files back to disk.

Installation

To use GBlorbLib in your project, add a reference to the library. If using Visual Studio, you can include the NuGet package.

Usage

Reading a GBlorb File

using Casasoft.IF.GBlorbLib;

// Load a GBlorb file 
GBlorb blorb = new("path/to/file.gblorb");

// Access header, resource index, and chunks 
Console.WriteLine(blorb.Header); 
Console.WriteLine(blorb.ResourceIndex); 
foreach (var chunk in blorb.Chunks) { Console.WriteLine(chunk); }

Exporting a Chunk

blorb.Export("path/to/export/directory");

Adding/Updating Optional Text Chunks

blorb.AddUpdateOptionalTextChunk("AUTH", "Author Name"); 
blorb.AddUpdateOptionalTextChunk("(c) ", "2025 Author Copyright"); 
blorb.AddUpdateOptionalTextChunk("ANNO", "Annotations or remarks");

Writing a Modified GBlorb File

blorb.Write("path/to/output.gblorb");

Online documentation

For detailed documentation, including API references, visit the GBlorbLib documentation site.

Links

Utilities
Browse Stable utilitiesSearch formDrilldown
Other software Authoring systemsInterpreters