• R/O
  • SSH

dwaddle: Repository summary

Main Dwaddle repository


Recent Commits RSS

Rev. Time Author Message
0ba3da959f0c 2021-11-07 19:24:22 Remilia Scarlet trunk tip Add marker lump to lists of level type required lumps
1f1237d9986f 2021-11-07 19:23:52 Remilia Scarlet trunk Back sidedef could be negative
b5c77fa969b7 2021-06-19 18:49:33 Remilia Scarlet trunk Use a specific commit
276998f1075f 2021-06-19 14:27:38 Remilia Scarlet trunk Merge trunk
7fb232440ecb 2021-06-19 14:27:08 Remilia Scarlet trunk Add various methods to improve texture/flat and level han...
11b31986baee 2021-06-19 14:26:40 Remilia Scarlet trunk Add #with_each_index method
64d0c0c6d9ca 2021-06-19 14:26:26 Remilia Scarlet trunk Move a method down a bit
aa0222d105ca 2021-06-19 14:25:22 Remilia Scarlet trunk Fix some logic in level detection, and add the #empty? me...
ac76615c8882 2021-05-26 20:22:00 Remilia Scarlet trunk Bump to correct libremiliacr version
3938dcc0e306 2021-05-26 20:16:23 Remilia Scarlet trunk Bump required libremiliacr version

Recently edited Tags

Name Rev. Time Author
tip 0ba3da959f0c 2021-11-07 19:24:22 Remilia Scarlet

Branches

Name Rev. Time Author Message
trunk 0ba3da959f0c 2021-11-07 19:24:22 Remilia Scarlet Add marker lump to lists of...

README.md

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

Show on old repository browser