Dwaddle

Dwaddle is a library for manipulating Doom WAD and PK3 files (and a few other things).

The library focuses primarily on stricter compliance to standards, with a secondary focus of not being too slow. It's meant to offer support for most mapping- and wad-related data structures through classes.

This is a rewrite from my old prototype code that was in Common Lisp.

How do I get set up?

clone this repository manually using Mercurial.

Usage

Dwaddle is hosted in a Mercurial repository. Until the Shards command supports Mercurial (see this PR), you will need to first clone Dwaddle manually.

After this, add something akin to this in your shard.yml file:

dependencies:
  dwaddle:
    # hg: https://hg.osdn.net/view/dwaddle/dwaddle # For future Mercurial support
    path: ../dwaddle/

Once Mercurial support is in Shards, you'll be able to remove the path: line and uncomment the hg: line.

Development

Style info

I use a slightly different style for my code.

• Keep lines 118 characters or shorter. Obviously sometimes you can't, but please try. Use 115 characters for Markdown files, though.
• Please use pascalCase for variable and method names. Use CamelCase for type names. Use UPPER_SNAKE_CASE for constants.
• The type name for exceptions end with Error. For example, ExternalProgramError.

How do I contribute?

I do not use Git - if you're reading this on Gitlab, you're looking at a mirror. Let the Crystal folks know you'd like them to support other VCSs.

1. Go to https://osdn.net/projects/dwaddle/scm/hg/dwaddle/ and clone the Mercurial repository.
2. Create a new branch for your feature.
3. Push locally to the new branch
4. Create a pull request on OSDN.

Contributors

Remilia Scarlet - creator and maintainer