fluidqueue/fluid-queue repository overview

⁠fluid-queue

A queue system for Super Mario Maker 2 levels.

This project is based on Queso Queue Plus, which was originally developed by Shoujo (https://github.com/ToransuShoujo/quesoqueue_plus/⁠) and diceguyd30 (https://github.com/diceguyd30/queso_to_go_template⁠).

To get started with the bot, check out the setup instructions⁠ on our site. If you have any issues, let us know by opening an issue⁠ on Github or joining our Discord server⁠!

⁠Docker Tags

⁠Contributing

Most of our contributing guidelines can be found in CONTRIBUTING.md⁠. Once you've read that, continue below!

⁠Building the bot

Since we develop in Typescript, in order to run the bot, you need to build the bot. You should be able to do this fairly easily, as long as you have git and Node.JS installed. We test against the current LTS Node.JS version, and target the latest LTS version. Make sure to use a compatible version of node which can be found in the package.json file.

$ git clone https://github.com/fluid-queue/fluid-queue.git
$ cd fluid-queue
$ git checkout develop # Only necessary if you're working on the develop branch
$ npm install --include=optional # Optional dependencies are needed for the build and the tests
$ npm run build
$ npm run clean # If you need to clean up the build directory

We use esbuild to build and bundle the code, so you'll end up with a single index.js file in your build directory, as well as the compiled contents of the src/extensions directory. The extensions are dynamically loaded, so they can't be bundled with the rest of the code, but they are bundled individually and minified. This also means that any custom extensions you write in Typescript and build with the bot will be bundled and minified, without needing to add them to the build script!

⁠Testing

To run tests:

$ npm test

If you get TypeError: Converting circular structure to JSON, try:

$ npm test -- --detectOpenHandles

To run tests without log output:

$ npm test -- --silent

To run a single test:

$ npm test -- -t custom-levels-v2.1-to-v2.2