Files
videobeaux/docs/_site/installation.html
2025-12-07 22:04:44 -05:00

144 lines
7.3 KiB
HTML

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- Begin Jekyll SEO tag v2.8.0 -->
<meta name="generator" content="Jekyll v3.10.0" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="The friendly multilateral video toolkit built for artists by artists." />
<meta property="og:description" content="The friendly multilateral video toolkit built for artists by artists." />
<link rel="canonical" href="http://localhost:4000/videobeaux/installation.html" />
<meta property="og:url" content="http://localhost:4000/videobeaux/installation.html" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"The friendly multilateral video toolkit built for artists by artists.","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"http://localhost:4000/videobeaux/assets/img/videobeaux.png"}},"url":"http://localhost:4000/videobeaux/installation.html"}</script>
<!-- End Jekyll SEO tag -->
<link rel="stylesheet" href="/videobeaux/assets/css/style.css?v=5e23701ed3967d38bab12937d79f95fae74b2a53">
<!--[if lt IE 9]>
<script src="https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
<![endif]-->
<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
<!-- Setup Google Analytics -->
<!-- You can set your favicon here -->
<!-- link rel="shortcut icon" type="image/x-icon" href="/videobeaux/favicon.ico" -->
<!-- end custom head snippets -->
</head>
<body>
<div class="wrapper">
<header>
<h1><a href="http://localhost:4000/videobeaux/">videobeaux</a></h1>
<img src="/videobeaux/assets/img/videobeaux.png" alt="Logo" />
<p>The friendly multilateral video toolkit built for artists by artists.</p>
<p class="view"><a href="https://github.com/schwwaaa/videobeaux">View the Project on GitHub <small>schwwaaa/videobeaux</small></a></p>
</header>
<section>
<hr />
<p>layout: default
title: Installation
nav_order: 4
</p>
<h1 id="macoslinux">macOS/Linux</h1>
<p>In the shell prompt, go to the place where you want the project to live. Paste that in a macOS Terminal or Linux shell prompt &amp; run it.</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>/bin/bash <span class="nt">-c</span> <span class="s2">"</span><span class="si">$(</span>curl <span class="nt">-fsSL</span> https://raw.githubusercontent.com/schwwaaa/videobeaux/refs/heads/main/install.sh<span class="si">)</span><span class="s2">"</span>
</code></pre></div></div>
<h1 id="windows">Windows</h1>
<div class="language-powershell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">choco</span><span class="w"> </span><span class="nx">install</span><span class="w"> </span><span class="nx">ffmpeg</span><span class="w">
</span><span class="n">setx</span><span class="w"> </span><span class="nx">VIDEOBEAUX_PATH</span><span class="w"> </span><span class="s2">"C:\videobeaux"</span><span class="w">
</span></code></pre></div></div>
<h1 id="usage">Usage</h1>
<h2 id="activate-virtual-environment">Activate virtual environment</h2>
<p>This will activate your virtual environment. Immediately, you will notice that your terminal path includes env, signifying an activated virtual environment.</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">source env</span>/bin/activate
<span class="c">### Check the installation</span>
<span class="c">### Get help and find out more about videobeaux</span>
<span class="sb">```</span> bash
videobeaux <span class="nt">--help</span>
</code></pre></div></div>
<p>… outputs the following …</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> _ _ _
__ _<span class="o">(</span>_<span class="o">)</span> __| | ___ ___ | |__ ___ __ _ _ ___ __
<span class="se">\ \ </span>/ / |/ _<span class="sb">`</span> |/ _ <span class="se">\/</span> _ <span class="se">\|</span> <span class="s1">'_ \ / _ \/ _` | | | \ \/ /
\ V /| | (_| | __/ (_) | |_) | __/ (_| | |_| |&gt; &lt;
\_/ |_|\__,_|\___|\___/|_.__/ \___|\__,_|\__,_/_/\_\
📺 The friendly multilateral video toolkit built for artists by artists.
🫂 It'</span>s your best friend!
🌐 https://schwwaaa.net
usage: videobeaux <span class="nt">--program</span> PROGRAM <span class="nt">--input</span> INPUT_FILE <span class="nt">--output</span> OUTPUT_FILE <span class="o">[</span>program options]
options:
<span class="nt">-P</span>, <span class="nt">--program</span> PROGRAM
Name of the effect program to run <span class="o">(</span>e.g. convert, glitch<span class="o">)</span>
<span class="nt">-i</span>, <span class="nt">--input</span> INPUT Input video file - mp4 only
<span class="nt">-o</span>, <span class="nt">--output</span> OUTPUT Output file name, no extension. Output will be saved as mp4.
<span class="nt">-F</span>, <span class="nt">--force</span> Force overwrite output file
<span class="nt">-h</span>, <span class="nt">--help</span> Show <span class="nb">help </span>message and <span class="nb">exit
</span>Available Program Modes:
bad_animation download_yt lsd_feedback_pro repainting subs_convert
bad_contrast extract_frames lut_apply resize t1000
bad_predator extract_sound meta_extraction reverse thumbs
ball_point_pen fever mince scrolling_pro tonemap_hdr_sdr
blur_pix frame_delay_pro1 mirror_delay septic transcraibe
broken_scroll frame_delay_pro2 nostalgic_stutter silence_xtraction triptych
captburn frame_interpolate num_edits slight_smear twociz
chain_builder gamma_fix overexposed_stutter smudge twociz_pro
chain_builder_pro ghostee overlay_img_pro soapblind watermark
convert hash_fingerprint pickle_juice speed wbflare
convert_dims lagkage qwikchop splitting wbflare_pro
convert_mux lagkage-old rb_blur splitting_pro wipe_transitions
crossmosh light_snow rb_blur_pro stack_2x xpiritualism
digital_boss looper_pro recalled_sensor steel_wash xrgb
double_cup lsd_feedback recalled_sensor_pro stutter_pro zapruder
</code></pre></div></div>
</section>
<footer>
<p>This project is maintained by <a href="https://github.com/schwwaaa">schwwaaa</a></p>
<p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
</footer>
</div>
<script src="/videobeaux/assets/js/scale.fix.js"></script>
</body>
</html>