feat: update policies, use new font, spell check (finally) (#44)

Reviewed-on: https://codeberg.org/nhcarrigan/docs/pulls/44
Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com>
Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
This commit is contained in:
2024-12-16 02:21:38 +00:00
committed by Naomi the Technomancer
parent de40813634
commit c34257ac0d
23 changed files with 1076 additions and 1856 deletions

View File

@ -316,7 +316,7 @@ When you're ready to commit your changes:
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 50 characters or less
- Additonal information can be included in the body
- Additional information can be included in the body
- Do NOT reference issues/PRs in your commit
Example:

View File

@ -558,7 +558,7 @@ IgnorePkg =
This is a complete list of all packages on the machine. This list is generated with `yay -Q`.
:::caution
This list is mega chonky.
This list is quite large.
:::
<details>
@ -2262,7 +2262,7 @@ J=#idlerpg-discuss
J=#idlerpg-ng
```
### 3.5 hyprland
### 3.5 `hyprland`
This is Naomi's `hyprland` config, which goes in `~/.config/hypr/hyprland.conf`.

View File

@ -6,7 +6,7 @@ This document outlines how we set up our remote servers for running projects.
## 1. Provision a Server
We use DigitalOcean as our provider. Regardless of your choice, provision a new VPS using the **latest Ubunutu LTS version**. Add your `ssh` key AND Naomi's `ssh` key in the setup process.
We use DigitalOcean as our provider. Regardless of your choice, provision a new VPS using the **latest Ubuntu LTS version**. Add your `ssh` key AND Naomi's `ssh` key in the setup process.
## 2. Set Up User
@ -289,11 +289,33 @@ And to unban them:
sudo fail2ban-client set nginx-auth unbanip <ip>
```
## 5. Running a Project
## 5. Uploading a Project
To upload a project, you should **not** use `git` to clone the project to the machine. Instead, start by cloning the project to your local environment and navigating to the directory:
```bash
git clone <url>
cd /path/to/project
```
:::tip
If you already have the project cloned, remove any ignored files such as `node_modules`, `prod`, or `coverage`.
```bash
rm -rf node_modules prod coverage <other directories and files>
```
Then sync the project up to the machine, ignoring the `.git` directory.
```bash
GLOBIGNORE='.git' scp -r ./* <server name>:/home/nhcarrigan/<project directory>
```
## 6. Running a Project
Now you are ready to start running the project.
### 5.1. Node.js
### 6.1. Node.js
Most of our projects will run on Node. For a new machine, you'll need to set that up.
@ -323,7 +345,7 @@ Finally, install `pnpm` as the package manager.
npm i -g pnpm
```
### 5.2. PM2
### 6.2. PM2
All of our processes run with PM2 to allow for monitoring and auto-restarts. You'll need to install it.

View File

@ -0,0 +1,54 @@
---
title: Naomi's VTubing Setup
---
Naomi uses her VTuber model for all of her client meetings, as well as streaming. Getting the software to work on Linux is a bit of a nightmare, so this page documents how she does so.
## 1. OpenSeeFace
In order to track her webcamera, OpenSeeFace needs to be run independently as a native script.
### 1.1. Installation
This should all be done in your home `~` directory.
- Begin by cloning the repository:
- `git clone https://github.com/emilianavt/OpenSeeFace`
- `cd OpenSeeFace`
- You will need to prepare Python
- Install the packages: `yay -Sy python python-virtualenv`
- Prepare the environment: `virtualenv -p python3 env`
- Source the environment: `source env/bin/activate`
- Install the dependencies: `pip3 install onnxruntime opencv-python pillow numpy`
### 1.2. Running
```
cd OpenSeeFace
source env/bin/activate
python facetracker.py -c 0 -W 1280 -H 720 --discard-after 0 --scan-every 0 --no-3d-adapt 1 --max-feature-updates 900
```
## 2. VSeeFace
VSeeFace does not run natively, and will need to run with Wine.
### 2.1. Installation
[Download and run the installer](https://www.vseeface.icu/#download). When selecting a directory, put it in `~/VSeeFace`.
### 2.2. Running
```bash
wine ~/VSeeFace/VSeeFace.exe --background-color "#00FF00"
```
The `--background-color` flag creates a green screen background to be chroma-keyed out by OBS.
## 3. OBS
OBS allows for virtual camera, as well as for streaming.
### 3.1. Installation
The `obs-studio-git` AUR package is Naomi's current installation.