Commit Briefs

b4c63f60ac Evan Burkey

Convert README from markdown to plaintext (master)





f76a6cd42e Evan Burkey

gitea


6f8346c3fc Evan Burkey

update docs, new_WAD


4d13ac6a73 Evan Burkey

docs


63e79490c9 Evan Burkey

implement write to file, start docs


1347c0741b Evan Burkey

update ci


3557439489 Evan Burkey

init


Branches

Tags

This repository contains no tags

Tree

.github/
.gitignorecommits | blame
CMakeLists.txtcommits | blame
DOOM1.WADcommits | blame
READMEcommits | blame
spitwad.ccommits | blame
spitwad.hcommits | blame
tests/

README

spitwad

A C library for reading, writing, and manipulating WAD files. The [WAD format](https://burkey.co/Software+Documentation/spitwad/WAD+Format) was created by id Software for DOOM and has since become a staple of game modding. spitwad treats WADs as a general-purpose archive format — use it for your DOOM clone, or package arbitrary data and send it over a network.

-- Quick Start --

cmake -B build
cmake --build build

#include "spitwad.h"

struct WAD wad;
wad_init(&wad, PWAD);
wad_add_lump(&wad, "GREETING", (const unsigned char *)"hello", 5);
wad_write_file(&wad, "hello.wad");
wad_destroy(&wad);

-- Requirements --

- CMake 3.22+
- C99 compiler
- Any POSIX platform (Linux, macOS, BSD)

-- Documentation --

Full API reference and format documentation: [burkey.co/Software Documentation/spitwad](https://burkey.co/Software+Documentation/spitwad/spitwad)