aboutsummaryrefslogtreecommitdiffstats
path: root/Writerside
diff options
context:
space:
mode:
authorPinapelz <yukais@pinapelz.com>2023-12-16 15:53:41 -0800
committerPinapelz <yukais@pinapelz.com>2023-12-16 15:53:41 -0800
commit2104ba52a8839aa74c6770d3faa0a8caafab8da9 (patch)
treee6e4213df6853affe160028eacd352d2bbceff74 /Writerside
parent9519ed41aa34c8bea10f081190847339c2a9d9ce (diff)
add IMissSomeone-VT
Diffstat (limited to 'Writerside')
-rw-r--r--Writerside/hi.tree1
-rw-r--r--Writerside/images/completion_procedure.pngbin128146 -> 0 bytes
-rw-r--r--Writerside/images/completion_procedure_dark.pngbin68718 -> 0 bytes
-rw-r--r--Writerside/images/convert_table_to_xml.pngbin349338 -> 0 bytes
-rw-r--r--Writerside/images/convert_table_to_xml_dark.pngbin121495 -> 0 bytes
-rw-r--r--Writerside/images/new_topic_options.pngbin293755 -> 0 bytes
-rw-r--r--Writerside/images/new_topic_options_dark.pngbin156186 -> 0 bytes
-rw-r--r--Writerside/topics/IMissSomeone-VT.md38
8 files changed, 39 insertions, 0 deletions
diff --git a/Writerside/hi.tree b/Writerside/hi.tree
index 70350b6..71badc9 100644
--- a/Writerside/hi.tree
+++ b/Writerside/hi.tree
@@ -5,6 +5,7 @@
<instance-profile id="hi"
name="Project Knowledge Base"
start-page="Welcome.md">
+ <toc-element topic="IMissSomeone-VT.md"/>
<toc-element topic="Welcome.md"/>
<toc-element topic="Patchwork-Archive.md">
<toc-element topic="Patchwork-API.md"/>
diff --git a/Writerside/images/completion_procedure.png b/Writerside/images/completion_procedure.png
deleted file mode 100644
index 3535a3f..0000000
--- a/Writerside/images/completion_procedure.png
+++ /dev/null
Binary files differ
diff --git a/Writerside/images/completion_procedure_dark.png b/Writerside/images/completion_procedure_dark.png
deleted file mode 100644
index a65beb0..0000000
--- a/Writerside/images/completion_procedure_dark.png
+++ /dev/null
Binary files differ
diff --git a/Writerside/images/convert_table_to_xml.png b/Writerside/images/convert_table_to_xml.png
deleted file mode 100644
index 2518a64..0000000
--- a/Writerside/images/convert_table_to_xml.png
+++ /dev/null
Binary files differ
diff --git a/Writerside/images/convert_table_to_xml_dark.png b/Writerside/images/convert_table_to_xml_dark.png
deleted file mode 100644
index 4716122..0000000
--- a/Writerside/images/convert_table_to_xml_dark.png
+++ /dev/null
Binary files differ
diff --git a/Writerside/images/new_topic_options.png b/Writerside/images/new_topic_options.png
deleted file mode 100644
index ea9744d..0000000
--- a/Writerside/images/new_topic_options.png
+++ /dev/null
Binary files differ
diff --git a/Writerside/images/new_topic_options_dark.png b/Writerside/images/new_topic_options_dark.png
deleted file mode 100644
index c919638..0000000
--- a/Writerside/images/new_topic_options_dark.png
+++ /dev/null
Binary files differ
diff --git a/Writerside/topics/IMissSomeone-VT.md b/Writerside/topics/IMissSomeone-VT.md
new file mode 100644
index 0000000..1b8a775
--- /dev/null
+++ b/Writerside/topics/IMissSomeone-VT.md
@@ -0,0 +1,38 @@
+# 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)
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage