Skip to content
theblackswitch edited this page Aug 9, 2026 · 6 revisions

Logo banner Welcome to the documentation!
Here you'll find refrences and examples on how to interact with the library. Let's get started!

🖥️ Installation

There are 3 install methods available. Pick the one that suits you the best.

NPM

$npm install @theblackswitch/yamp

ES module

import * as YAMP from "https://cdn.jsdelivr.net/npm/@theblackswitch/yamp@latest/dist/main.js"

HTML Script

<script src="https://cdn.jsdelivr.net/npm/@theblackswitch/yamp@latest/dist/main.global.js"></script>

⚡Getting started

🫂Collaboration

Thanks for your interest in collaborating, we love your intent to improve this open source project.

All of our code is written in the src folder. We use standard typescript as a pre-compiler and would like to keep this library without any dependancies.

A dev environment is already included under demo. Build the project using npm run build This will automatically build all distribution formats and copy over the library to your demo folder.

This way you can use npm run demo which will load up a local server on http://localhost:8001 to test out your changes. Open this in your preferred web browser.

Warning

Fully AI generated commits won't be accepted so don't even bother.

📜License


YAMP © 2026 by theblackswitch is licensed under GPL v3.0.

Additional condition: The content of this work, as a whole or in parts, may not be used for training, fine-tuning, or enhancement of artificial intelligence systems, machine learning models or any other type of program where computers use data and algorithms to learn patterns and make predictions without being explicitly programmed. This includes, not only and all, for commercial, non-commercial, educational, research, or personal projects.


Clone this wiki locally