Skip to content

Image title

Minr Player Utility Documentation

This is a Material for MkDocs website for hosting documentation for the tools written by players for the server zero.minr.org. Conceptually similar to the celeste helper list.

What is this site for?

This site is for all minr players!

  • It's for mappers, who want to find mapping-oriented tools, such as [TODO: example] or [TODO: example]. Any utility tagged with Mapping can be imported and used, with no scripting neccessary.
  • It's for scripters, who want to know what to build off of. Ever wanted to [TODO: example]? Any utility tagged with Scripting is a library that you can use in your code.
  • It's for players, who get better maps!

Check out all documented utilities at All Utilities

For information on how you can document your scripts here, check out How to Document Your Utility

A Note About Dependencies

In the javascript world, there's an environment known as Node.js. You've encountered it if you've ever tried to write a discord bot. It's the most popular backend environment that exists.

And with that popularity comes hell. Specifically, dependancy hell. Node.js is infamous for its sprawling dependancy trees, leading to nigh-undebuggable problems. You can install the package everything, which has over a million dependancies and will instantly ban you from npm. The package is-even checks if a number is even, and had 165,708 downloads this week.

Minr is probably worse.

If you use a namespace that you don't control, and especially if you use a namespace that you don't have the source code of, it's succeptible to all sorts of problems.

  • Data loss from the code updating
  • Data loss from somebody else using the namespace the wrong way
  • Unexpected functionality changing when code updates
  • The utility doesn't work as it should
  • The utility has an exploit, causing all dependants to be succeptible
  • And so on...

For these reasons, the Core tag exists. These are utilities that are widely-used, safe to use, or otherwise reputable in the community. If you're looking for specific functionality, seek these out first, and use your best judgement before building on top of newer, smaller utilities.

Ultimately, I can't really speak more about this, since I have no software infrastructural skills. So I'll stop here. Hopefully together, we can avoid a minr left-pad incident (you guessed it, also Node.js! Incredible piece of software that is)