====== Documentation for Muragami's Projects ======

Here it is, however incomplete or limited. I will make sure I note how complete docs are for each, so you'll know going in what to expect. Most of these are hosted on [[https://github.com|GitHub]], under my username: [[https://github.com/Muragami|Muragami]]. Links into the main doc page for each below:

You can also return to my website [[https://muragami.wishray.com|here]].
===== Maxrects-lua =====

  * [[https://github.com/Muragami/Maxrects-lua|GitHub Page]] - The source in lua (and LÖVE).
  * [[https://www.david-colson.com/2020/03/10/exploring-rect-packing.html|Exploring rectangle packing]] - Write-up exploring various algorithms for packing (Maxrects is a type of grid splitting) by David Colson.

Docs: [[Maxrects-lua]]

An implementation of the MAXRECTS 2d rectangle packing algorithm in Lua, somewhat optimized for LuaJIT. It is pretty flexible, as it just packs rectangles. You can attach a field in the rectangle called data, and that can hold your information about the specific rectangle (for instance, image information).

Simple Video Demonstration of hot packing action:
{{ :maxrects.mp4 |}}

===== Rogue-lua =====

  * [[https://github.com/Muragami/Rogue-lua|GitHub Page]] - The source in lua (and LÖVE).
  * [[https://britzl.github.io/roguearchive/|Rogue Archive]] - An archive of the many versions of Rogue.

Docs: [[Rogue-lua]]

An re-implementation of [[https://en.wikipedia.org/wiki/Rogue_(video_game)|Rogue]] 5.2.1 in Lua for [[https://love2d.org|LÖVE]]. Important to note, this is not a port but instead a new implementation of the logic I scrubbed from the 5.2.1 source. While this project will offer a game itself, using minimal graphics, more importantly it creates a Rogue-lua library for the logic of the game. This means it can be expanded upon and retooled for any purpose you desire.

===== cppSfxr =====

  * [[https://github.com/Muragami/cppSfxr|GitHub Page]] - The source in C++ with bindings.
  * [[https://www.drpetter.se/project_sfxr.html|Sfxr homepage]] - The original version.

Docs: [[cppSfxr]]

Sfxr recoded and enhanced as a C++ library with DLL and FFI bindings.