8000 GitHub - fluid-queue/fluid-queue: A queue system for Super Mario Maker 2 levels
[go: up one dir, main page]

Skip to content

fluid-queue/fluid-queue

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

537 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Node.js CI Docker Cloud Automated build GitHub (Pre-)Release Date

Discord Documentation on fluid-queue.dev

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

Tag Rule Description
fluidqueue/fluid-queue:latest Every push to main The latest stable updates.
fluidqueue/fluid-queue:develop Every push to develop The bleeding-edge. May not be as stable, but will always be up to date.
fluidqueue/fluid-queue:release-* Every manually tagged stable release (v1.2.3, etc) Specific stable versions.
fluidqueue/fluid-queue:2.0.0-beta.1
(and similar version tags)
Every manually tagged prerelease. Specific alpha/beta/prerelease versions. Tagged on git as just the version number, rather than with a prefixed v.

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

About

A queue system for Super Mario Maker 2 levels

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 8

0