https://github.com/randomgamingdev/qr-cartridge
A basic build system including library importing from URLs for creating code that can be stored onto QR codes and ran directly off of them on the browser.
https://github.com/randomgamingdev/qr-cartridge
build build-system build-tool buildsystem cartridge cartridges compiler qrcode qrcode-generator small tiny
Last synced: 2 months ago
JSON representation
A basic build system including library importing from URLs for creating code that can be stored onto QR codes and ran directly off of them on the browser.
- Host: GitHub
- URL: https://github.com/randomgamingdev/qr-cartridge
- Owner: RandomGamingDev
- License: mit
- Created: 2023-06-17T22:47:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-01T15:10:36.000Z (about 1 year ago)
- Last Synced: 2025-03-30T05:41:15.219Z (3 months ago)
- Topics: build, build-system, build-tool, buildsystem, cartridge, cartridges, compiler, qrcode, qrcode-generator, small, tiny
- Language: JavaScript
- Homepage:
- Size: 29.3 KB
- Stars: 25
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# qr-cartridge
A basic build system including library importing from URLs for creating code that can be stored onto QR codes and ran directly off of them on the browser.
### Examples
There's a basic example for quickstarting [here](https://github.com/RandomGamingDev/qr-cartridge/tree/main/example)!
Another project that uses it is [qr-flappy-bird](https://github.com/RandomGamingDev/qr-flappy-bird) which is a very close recreation of flappy bird with assets and everything :D
Here's a video explaining how that project was made https://www.youtube.com/watch?v=CDMbnNxvrVM
### How to use
Simply create a directory containing a `.config` file with your filepaths to your code behind the `code:` tag and external libraries imported from URLs behind the `external:`. (btw don't indent the URLs or anything else just paste them in after the line with the tag)
Tags can be used multiple times and everything is imported in order.
Then simply download the dependencies using `npm install` and then execute `comp.cjs` using NodeJS and follow the instructions or use the CLI argv inputs like this: `node comp.cjs `
A `build` file will then be generated next to the config file containing everything you need.
Please Note: A few characters like `#` for instance will cut off the code at that point because of URL fragments.
### Use it anywhere!
Because of the incredibly small size of javascript when properly minified alongside the wide browser support and the fact that the browsers do all the heavy lifting this is one of the perfect ways to create QR codes for tiny applications that anyone could use without requiring the internet!
tbh if you're reading this the problem probably isn't that you don't have internet, but this project's a decently fun gimmick and it's really nice to see just how much you can fit onto a simple QR code :D