Skip to content

Commit 8cb9e47

Browse files
Create install.md
1 parent db391bd commit 8cb9e47

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/install.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Installation Instructions
2+
3+
## Basic Installation
4+
5+
### Windows
6+
7+
1. Download the MSUScripterSetupWin file from the [latest release](https://github.com/MattEqualsCoder/MSUScripter/releases)
8+
2. Run the executable to install
9+
3. Install all dependencies in the dependency installer window
10+
11+
### Linux
12+
13+
1. Install [.NET 9.0](https://learn.microsoft.com/en-us/dotnet/core/install/linux)
14+
- Make sure that dotnet is in the PATH
15+
- If you need multiple versions of .NET installed, you may want to use te [scripted install](https://learn.microsoft.com/en-us/dotnet/core/install/linux-scripted-manual#scripted-install)
16+
2. Download the MSUScripterLinux tar file from the [latest release](https://github.com/MattEqualsCoder/MSUScripter/releases)
17+
3. Make the MSUScripter file executable to run or run the command `dotnet MSUScripter.dll`
18+
4. Install all dependencies in the dependency installer window
19+
20+
## Manual Dependency Installation
21+
22+
With the exception of msupcm++, you can install the dependencies manually. This can be useful to preserve space if you are going to use FFmpeg or Python for other things.
23+
24+
### FFmpeg
25+
26+
FFmpeg is used by the Python Companion App to create YouTube videos for testing for copyright strikes.
27+
28+
1. Download [FFmpeg](https://www.ffmpeg.org/download.html)
29+
2. Make sure FFmpeg is available in your PATH
30+
3. To verify you should be able to open up a new terminal/command prompt window and simply type in `ffmpeg -version` to get a response
31+
32+
### Python Companion App
33+
34+
1. Download and install [Python](https://www.python.org/downloads/) (not needed on Linux)
35+
2. Download and install [pipx](https://pipx.pypa.io/stable/installation/)
36+
- Make sure to run `pipx ensurepath`
37+
3. Run the command `pipx install py-msu-scripter-app`
38+
- If preferred, you can also install pip and install via `python -m pip install py-msu-scripter-app` or `pip install py-msu-scripter-app` based on your environment

0 commit comments

Comments
 (0)