From c95c0a56cd994ff09c3aee767949a88752642409 Mon Sep 17 00:00:00 2001 From: Pinapelz Date: Sun, 7 Apr 2024 01:19:17 -0700 Subject: migrate docs to vitepress --- docs/i-miss-someone-vt.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/i-miss-someone-vt.md (limited to 'docs/i-miss-someone-vt.md') diff --git a/docs/i-miss-someone-vt.md b/docs/i-miss-someone-vt.md new file mode 100644 index 0000000..e172a5e --- /dev/null +++ b/docs/i-miss-someone-vt.md @@ -0,0 +1,41 @@ +--- +title: IMissSomeone-VT Docs +lang: en-US +--- +# IMissSomeone-VT +Miss your favorite VTuber? "I Miss Someone VT" is a template for deploying a fansite for any particular VTuber. + +This page serves as documentation for necessary configuration + +# Environment Variables +The Flask backend relies on environment variables for configuration. + +- **KV_REST_API_URL** + - Redis KV database REST API URL +- **KV_REST_API_TOKEN** + - Redis KV API Token +- **FREE_CHAT_ID** + - Video ID of the free chat/waiting room. The thumbnail from this scheduled waiting room is used as the schedule page PNG +- **CHANNEL_ID** + - YouTube Channel ID of the tracked channel +- **API_KEY** + - Holodex API Key +- **MANUAL_OVERRIDE** + - In case Holodex misreports a video as a stream, this can be used to ignore a particular video (insert video ID) + +# Site Config +The configuration for the frontend can be found within `site-config.json` + +- **soundUrls** + - List of soundbites that will play when the button is clicked +- **rareSoundUrls** + - An extended list of soundUrls but these will only play 10% of the time +- *pastImages* + - A list of images that are cycled through on the landing page +- *buttonIcon* + - Icon that appears in the background when the button is clicked (img) + +The project itself is reliant on Holodex API for data and Redis KV for storing information regarding the button's global click count + + +![](https://github.com/pinapelz/pinapelz/assets/21994085/cc0f1230-76a4-416c-8aa7-eb88172679b4) -- cgit v1.2.3