muddy

HEY!

HEY!

Do you love muddler?? ME TOO!!! If you don't, then you it only stands to reason that you are entirely ignorant of the amazing work of @demonnic. And that is inexcusable. Because he is a god and you need to worship at the altar that is his amazing work.

That said, I wish it weren't written in Java, cos I can't help. :'(

But I know a few bars of JavaScript.

I have tried to make muddy work as closely to muddler as I could. Maybe it worked, maybe I failed miserably. idfk, it Works on My Computer™.

My version is a clean-room implementation and I haven't even peeked at demonnic's, because, frankly, as implicated above, I am woefully inadequate for the Java. Which, honestly? I'm fine with.

So, if you want to use muddy, the syntax is the same. The structure it expects is the same. The output is... errr, probably... the same... ish?

I'm not gonna re-teach you how to use an identical cli-based thing, when, to repeat, the amazing god that is demonnic has already strived... strove... striven? to do it already and it's great.

The only difference between invoking muddy over muddler is the cli.

Immediate Invocation

# npm
npx @gesslar/muddy --help

# npm
npx @gesslar/muddy --help

Install as a dependency, if you want, you don't have to

# npm
npm add -d @gesslar/muddy

# npm
npm i -d @gesslar/muddy

Post Hocktuah

Also, shout out to @Edru2 for DeMuddler which is just sex on a stick.

Which is exactly how everybody likes their sex, yes? Yes. Okay.

Features unique to muddy

Add modules

muddy can scaffold new modules directly from the command line using --add. This creates the type directory (if needed), adds an entry to the {type}.json with all available fields from the schema pre-filled, and creates an empty .lua file — ready for you to fill in.

# Add a named script
muddy . --add script --name "My Script"

# Add an alias with auto-generated temp name (new_alias_1, new_alias_2, ...)
muddy . --add alias

# Short form
muddy . -a trigger --name "Health Warning"

Valid types: alias, key, script, timer, trigger.

Ignore patterns

muddy supports an ignore field in your mfile that lets you exclude files from both module collection and resource injection. This is not available in muddler.

Add an ignore array to your mfile with glob patterns:

{
  "package": "MyPackage",
  "version": "1.0.0",
  "ignore": ["**/drafts/**", "**/wip/**", "**/experimental_*"]
}

Patterns are matched against relative paths within src/. They apply to:

• Module collection — any scripts.json, aliases.json, etc. matching an ignore pattern will be skipped entirely, along with their associated Lua files.
• Resource injection — any files under src/resources/ matching an ignore pattern will not be copied into the .mpackage.

Standard glob syntax is supported (e.g. *, **, ?). If ignore is omitted or empty, all files are included as usual.

License

@gesslar/muddy is released into the public domain under the 0BSD.

This package includes or depends on third-party components under their own licenses:

| Dependency | License | | --- | --- | | @gesslar/actioneer | 0BSD | | @gesslar/colours | 0BSD | | @gesslar/toolkit | 0BSD | | adm-zip | MIT | | commander | MIT | | xmlbuilder2 | MIT |

Postmate

did you know there's a javascript.com?? I just found that out. holy shit.