Skip to content

Latest commit

 

History

History
91 lines (56 loc) · 3.09 KB

readme.md

File metadata and controls

91 lines (56 loc) · 3.09 KB

AKVJ - Adventure Kid Video Jockey

A VJ application focused on pixel and 8-bit graphics, built with Web MIDI API, Canvas, vanilla JavaScript, custom HTML elements, and PNG sprites for Frames. The project is developed and served using Vite, with basic formatting and linting handled by Prettier and Stylelint.

AKVJ listens to MIDI notes from all inputs, using the channel number and note number to display different visuals and animations. Each note triggers a unique animation, and each channel adds a layer to the canvas, with channel 0 being the furthest in the back.

Table of Contents

Introduction

This project is a Vite-based application designed for AKVJ. It provides a foundational setup and configuration for both development and production environments.

Usage

hello

Installation

The basic installation uses the standard npm install command. Additionally, I’ve added a few npm scripts to clean up and upgrade packages. Since this is meant to be run locally, for example, on a screen in a live setting, the packages should always be updated to the latest versions. There shouldn’t be any problems caused by this, as the dependencies are there to aid development.

Init

npm install

Development

Vite runs a local dev server. URI in terminal.

npm run dev

Build

Vite builds to ./dist/ folder.

npm run build

Scripts

Some extra scripts to clean up and keep dependencies updated.

Prune and install

npm run fix-install

Prune, fix and install

npm run fix-quick

Upgrade dependencies

npm run fix-upgrade

Remove dependencies, upgrade, clean install

npm run fix-deep

License

MIT License

Copyright (c) [Year] [Your Name]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Exclusions: This license does not grant permission to use, copy, modify, merge, publish, distribute, sublicense, and/or sell any animations included in the repository.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.