README.md

js13kGames bot

js13kGames automatic submission validation

Exposes an endpoint to run checks on a bundle.zip

• valid size
• valid zip file
• contains index.html
• runs without errors
• runs without requesting external resources
• runs without display a blank screen at launch

Table of Content

• Usage
  • Endpoint
  • Result
  • Demo
    • xhr
    • pure html
• Third party
• License

Usage

Endpoint

curl -X POST \

  # upload your bundle.zip
  --form [email protected] \

  # set the rules for the desktop + mobile categories
  --form category=desktop \
  --form category=mobile \

  # temporary dev endpoint
  https://wdbnnia6lj.execute-api.eu-west-1.amazonaws.com/stage/analyze-bundle

Result

type Res = {
  // list of checks runs
  checks: {
    id: string;

    // description of what is expected for this check to succeed
    description: string;

    // result of the check
    result: "ok" | "failed" | "untested";

    // if failed, some details / hint on how to fix
    details?: string;
  }[];

  // url to the deployed game, or null if it did not get that far
  deployUrl?: string;

  // list of categories found in the request
  categories: (
    | "desktop"
    | "mobile"
    | "webxr"
    | "server"
    | "webmonetization"
    | "decentralized"
    | "unfinished"
  )[];

  // rules applying to this combinaison of categories
  // or null if no rule could be applied
  rules: Rules | null;
};

Demo

A very simple form

And an even simpler one without js

There is some bundle.zip samples in packages/bundle-analyzer/__fixtures__

Third party

Thanks to browserstack for supporting open source projects.

License

MIT