Update README.md

Format fixes and added examples
This commit is contained in:
RogueRen 2024-08-08 16:27:05 +00:00
parent 182b9980d7
commit da40a64f3b

View file

@ -72,6 +72,8 @@ Fedora: `sudo dnf install` followed by the name
Arch: `sudo pacman -Syu` followed by the name Arch: `sudo pacman -Syu` followed by the name
So for example, I want to install `easyeffects` on Linux Mint which is Ubuntu based. I would use `sudo apt install easyeffects`
OPTIONAL Prerequisites: OPTIONAL Prerequisites:
- Install Proton-GE either by using ProtonUp-QT: https://flathub.org/apps/net.davidotek.pupgui2 - Install Proton-GE either by using ProtonUp-QT: https://flathub.org/apps/net.davidotek.pupgui2
@ -91,19 +93,19 @@ or by using ProtonPlus: https://flathub.org/apps/com.vysp3r.ProtonPlus
- Optional UVC compliant Capture card like the Pcie EZCAP/Pyle LINK capture cards for console or second pc capture , alternatively you can also use NDI capture over the network (NDI capture Can add lag so be aware of this) - Optional UVC compliant Capture card like the Pcie EZCAP/Pyle LINK capture cards for console or second pc capture , alternatively you can also use NDI capture over the network (NDI capture Can add lag so be aware of this)
#STARTING OUT ON LINUX # STARTING OUT ON LINUX
Hello Everyone this is KyloNeko and I am here with a guide to help you get started on Linux! This is a Guide that is Intended to be a way for Vtubers to want to be able to Move away from Windows (or Mac) or People who were not too Keen on the windows Recall Feature, I hope this guide helps a lot of people out as it took me awhile to switch over and get things worked out, but trust me it works out correctly as I have done a lot of testing on Linux with Various applications that I daily Drive. Make sure you find or test a Linux distro that you intend to use long term you can use Distro Sea to help you figure this out: https://distrosea.com/ . Once you have selected your flavor of Distro you can then proceed to the next step. Hello Everyone this is KyloNeko and I am here with a guide to help you get started on Linux! This is a Guide that is Intended to be a way for Vtubers to want to be able to Move away from Windows (or Mac) or People who were not too Keen on the windows Recall Feature, I hope this guide helps a lot of people out as it took me awhile to switch over and get things worked out, but trust me it works out correctly as I have done a lot of testing on Linux with Various applications that I daily Drive. Make sure you find or test a Linux distro that you intend to use long term you can use Distro Sea to help you figure this out: https://distrosea.com/ . Once you have selected your flavor of Distro you can then proceed to the next step.
#Installing your distro # Installing your distro
Ok you made it this far after you selected your flavor of Distro , you can now grab a Flash Drive and then either use Balena Etcher: https://etcher.balena.io/ or rufus: https://rufus.ie/en/ Ok you made it this far after you selected your flavor of Distro , you can now grab a Flash Drive and then either use Balena Etcher: https://etcher.balena.io/ or rufus: https://rufus.ie/en/
Select your drive you intend to use, locate the `.iso` file you downloaded and then proceed to flash it to the usb drive, once you do that , I HIGHLY suggest you also BACK UP any files you wanted to keep from windows to a different drive or use google drive , and then reboot your pc and either go into the bios and select your LINUX bootable drive as the option or press F12 Repeatedly until the drive options appear , you will then be able to boot into a Linux bootloader called grub , you can then select the top option (usually) and then be able to boot into a welcome screen. Make sure you do everything the welcome screen install tells you to (and maybe play around with the os more before you install) and then once your distro is installed you can then be notified to reboot into the os. After you have done that you will be given another welcome screen to follow and install any updates or drivers you deem necessary. Select your drive you intend to use, locate the `.iso` file you downloaded and then proceed to flash it to the usb drive, once you do that , I HIGHLY suggest you also BACK UP any files you wanted to keep from windows to a different drive or use google drive , and then reboot your pc and either go into the bios and select your LINUX bootable drive as the option or press F12 Repeatedly until the drive options appear , you will then be able to boot into a Linux bootloader called grub , you can then select the top option (usually) and then be able to boot into a welcome screen. Make sure you do everything the welcome screen install tells you to (and maybe play around with the os more before you install) and then once your distro is installed you can then be notified to reboot into the os. After you have done that you will be given another welcome screen to follow and install any updates or drivers you deem necessary.
#Install steam & Proton/GE-Proton # Install steam & Proton/GE-Proton
Steam Proton is a very valuable aspect of this whole thing as it is the one that is able to interface with a lot of the applications here , so use the links above and download steam and get Vtube studio , or the other applications mentioned above as possible alternatives. Once you have signed into steam make sure you also go to Settings - > Compatibility - > enable steam play - > then reboot steam once you are prompted , get the ge proton flatpak verson and update your wine dependencies with the links above, Note to install a flatpak use terminal as shown here: Steam Proton is a very valuable aspect of this whole thing as it is the one that is able to interface with a lot of the applications here , so use the links above and download steam and get Vtube studio , or the other applications mentioned above as possible alternatives. Once you have signed into steam make sure you also go to Settings - > Compatibility - > enable steam play - > then reboot steam once you are prompted , get the ge proton flatpak verson and update your wine dependencies with the links above, Note to install a flatpak use terminal as shown here:
@ -111,7 +113,7 @@ And it should install after you pressed enter , or if you are on Linux mint , po
Open up ProtonUp-Qt or ProtonPlus and install the latest Proton verson ( in as the writing of this guide (GE-Proton9-11) works the best rn Open up ProtonUp-Qt or ProtonPlus and install the latest Proton verson ( in as the writing of this guide (GE-Proton9-11) works the best rn
#Vtube Studio # Vtube Studio
Firstly grab Vtube studio off of steam and install it , go into the compatibility settings and choose either ProtonExperimental or use the latest Ge-Proton verson , then go into the files and navigate to streaming assets , Put the Ip.txt file : https://gist.github.com/DenchiSoft/122729d9a0bd0f96798bea28bfe146d6 from here after you downloaded it and put it in the streaming assets folder and it should look like this : Firstly grab Vtube studio off of steam and install it , go into the compatibility settings and choose either ProtonExperimental or use the latest Ge-Proton verson , then go into the files and navigate to streaming assets , Put the Ip.txt file : https://gist.github.com/DenchiSoft/122729d9a0bd0f96798bea28bfe146d6 from here after you downloaded it and put it in the streaming assets folder and it should look like this :
@ -124,7 +126,7 @@ Once youre in Vtube studio you will notice a few things are off. Like your ey
After you have made your adjustments to your model you will then need to go to obs After you have made your adjustments to your model you will then need to go to obs
#OBS Studio # OBS Studio
Now Unfortunately the Plugin for Spout 2 Doesnt work in Obs (on linux) as of right now , But there's at least 2 alternatives. You can either use a Chroma Keyed Window Capture , or you can enable NDI capture for Vtube studio. In my experience the Window Capture method is the best as it offers No latency despite the UI being visible so that is what will be covered in this guide. Now Unfortunately the Plugin for Spout 2 Doesnt work in Obs (on linux) as of right now , But there's at least 2 alternatives. You can either use a Chroma Keyed Window Capture , or you can enable NDI capture for Vtube studio. In my experience the Window Capture method is the best as it offers No latency despite the UI being visible so that is what will be covered in this guide.
First go to OBS and select Window Capture(Xcomposite) then select VtubeStudio it should look like this after you load your model in: First go to OBS and select Window Capture(Xcomposite) then select VtubeStudio it should look like this after you load your model in:
@ -144,7 +146,7 @@ Make sure the live2d window is open though or you will be greeted with a black s
#VTS POG TTS application # VTS POG TTS application
Hello again so after switching to Linux I wanted to find a way to use VTS Pog Hello again so after switching to Linux I wanted to find a way to use VTS Pog
@ -175,7 +177,7 @@ And it should work, also Live 2d models will work if you load them in as items a
Here is a Video guide for VTS POG as well that I made showcasing what is possible : https://youtu.be/lE5g9CSwmfE Here is a Video guide for VTS POG as well that I made showcasing what is possible : https://youtu.be/lE5g9CSwmfE
#Mix it Up # Mix it Up
So recently I got Mix it Up working on linux and I want to be able to share my findings , this one is a bit more simple than the other parts of the guide but you will need to do a few things: So recently I got Mix it Up working on linux and I want to be able to share my findings , this one is a bit more simple than the other parts of the guide but you will need to do a few things:
@ -205,7 +207,7 @@ Create a Browser source and put this in the url part of it as on linux the copy
Next follow this video guide by Demythical to add your redeems https://youtu.be/mRpHrXeK5s0 Next follow this video guide by Demythical to add your redeems https://youtu.be/mRpHrXeK5s0
Tada now you should have redeems working with obs and vtube studio! Tada now you should have redeems working with obs and vtube studio!
#Twitch Integrated Throwing system # Twitch Integrated Throwing System
Prerequisites: Prerequisites:
T.I.T.S: https://remasuri3.itch.io/tits T.I.T.S: https://remasuri3.itch.io/tits
@ -233,23 +235,23 @@ Make sure the color key is : 323232 as this will allow for transparency
Follow this video to make redeems for TITS by maddiekuma: https://www.youtube.com/watch?v=hWOIZqv-u50 happy throwing! Follow this video to make redeems for TITS by maddiekuma: https://www.youtube.com/watch?v=hWOIZqv-u50 happy throwing!
#VmagicMirrior on Linux # VmagicMirrior on Linux
A good indepth video can be found here : https://www.youtube.com/watch?v=S7t5EVSNx9k this is by Cyb3r-Kun A good indepth video can be found here : https://www.youtube.com/watch?v=S7t5EVSNx9k this is by Cyb3r-Kun
#3D Vtubing # 3D Vtubing
Follow this video made by Robo nTux Guides : the Veeseeface section is explained greatly here: https://youtu.be/H0YotaNSbDc?si=FyiimfEbSMJmYNDL&t=223 also for obs game capture you will need Obs-Vkcapture installed https://github.com/nowrep/obs-vkcapture as far as im aware Vtube Studio doesnt play nicely with linux gamecapture as a launch option just yet but veeseeface should Follow this video made by Robo nTux Guides : the Veeseeface section is explained greatly here: https://youtu.be/H0YotaNSbDc?si=FyiimfEbSMJmYNDL&t=223 also for obs game capture you will need Obs-Vkcapture installed https://github.com/nowrep/obs-vkcapture as far as im aware Vtube Studio doesnt play nicely with linux gamecapture as a launch option just yet but veeseeface should
The launch option you would use in Bottles after you made the runner and got the program added as a shortcut would be obs-gamecapture %command% The launch option you would use in Bottles after you made the runner and got the program added as a shortcut would be obs-gamecapture %command%
#AUDIO # AUDIO
Using one of the audio patch bays to help route audio please look at this video for an explanation : https://www.youtube.com/watch?v=TDBGsbwMo40 Using one of the audio patch bays to help route audio please look at this video for an explanation : https://www.youtube.com/watch?v=TDBGsbwMo40
#Contributing? # Contributing?
If you would like to contribute to the Linux Guide to Vtubing you can reach me at nekokylo@gmail.com or on twitter at @KyloNek0 If you would like to contribute to the Linux Guide to Vtubing you can reach me at nekokylo@gmail.com or on twitter at @KyloNek0