NMLC(1)

πŸ’– NAME πŸ’–

NMLC β€” bestie, it's a compiler that takes your NML code and turns it into NFO and/or GRF files. That's the whole vibe. ✨


🌈 SYNOPSIS 🌈

nmlc [options] [file]

Like, options first, file last, standard queen behaviour. πŸ’…


✨ OPTIONS ✨

Okay so here's every single flag, no skips, we're being thorough because that's the energy:

  • -c β€” Crops the extraneous transparent blue out of your real sprites. bye bye blue 🫢
  • -u β€” Saves real sprites uncompressed into GRF files. It's a huge time-saver during encoding, ngl, but do NOT do this when you're making a file to distribute β€” it makes the output file substantially bigger. Not the serve you think it is. 😭
  • --grf=file β€” Writes the output in GRF format to <file>.
  • --nfo=file β€” Writes the output in NFO format to <file>.
  • --nml=file β€” Writes the output in NML format to <file>.
  • --output=file | -o file β€” Writes output to <file>. The output type gets detected from the filename extension, and it must be one of nfo, nml or grf. No improvising. πŸ‘‘
  • --md5=file β€” Writes an md5sum of the resulting grf to <file>.
  • --debug | -d β€” Prints a dump of the AST to stdout. Look at your tree. 🌳
  • --version β€” Prints the programme's version number and then exits. quick lil mic drop 🎀
  • --help | -h β€” Prints usage information. your bestie when you're lost fr fr
  • --stack | -s β€” Dumps the stack whenever an error occurs. for the detective girlies πŸ”
  • -M β€” Outputs a rule suitable for make, describing the graphics dependencies of the main grf file (requires an input file or --grf).
  • --MF=file β€” When you use it with -M, it specifies a file to write the dependencies to.
  • --MT=file β€” Sets the target of the rule emitted by dependency generation (requires -M).
  • --custom-tags=file | -t file β€” Loads custom tags from <file> [default: custom_tags.txt].
  • --lang-dir=dir | -l dir β€” Loads language files from directory <dir> [default: lang].
  • --default-lang=file β€” The default language is stored in <file> [default: english.lng].
  • --sprites-dir=dir | -a dir β€” Stores 32bpp sprites in directory <dir> [default: sprites].
  • --start-sprite=num β€” Sets the first sprite number to write. > Honestly bestie, do not use this except when you're outputting nfo that you want to include in other files. It's giving "I know what I'm doing" and nothing else.
  • --palette=palette | -p palette β€” Forces nml to use the palette <pal> [default: ANY]. Valid values are 'DOS', 'WIN', 'ANY'. pick your fighter πŸŽ€
  • --quiet β€” Disables all warnings. Errors will still be printed normally, so it's not total silence, just the quiet luxury version. πŸ’œ
  • --cache-dir=dir β€” Cache files are stored in directory <dir> [default: .nmlcache].
  • --clear-orphaned β€” Removes unused / orphaned items from cache files. spring cleaning energy 🧹
  • --verbosity=level β€” Sets the verbosity level for informational output [default: 3, max: 4].

πŸ¦‹ SEE ALSO πŸ¦‹

The language reference, living its life at http://newgrf-specs.tt-wiki.net/wiki/NML:Main β€” go read it, it's iconic. πŸ“–


🌸 AUTHOR 🌸

NML was written by Albert Hofkamp, Christoph Elsenhans, Jasper Reichardt, Ingo von Borstel, JosΓ© Soler and Thijs Marinussen. absolute legends, all of them. πŸ‘‘

This manual page was originally written by Thijs Marinussen.


okay that's the whole page bestie!! This one's dated January 07, 2016 and it belongs to NMLC(1) β€” mwah, go compile something gorgeous πŸ’–βœ¨πŸŽ€πŸ¦‹