From ce00f7e95bbe9252855c917679d3da8bb802006f Mon Sep 17 00:00:00 2001 From: Morichalion <60294388+Morichalion@users.noreply.github.com> Date: Fri, 27 Jan 2023 06:45:06 -0600 Subject: [PATCH] Initial guide --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 51f926e..cba41ca 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # Mori-Shark-Factory A simple tool that abstracts the command-line arguments for nod-ai/SHARK +Works + +It's written in Godot 4 beta 15. + +I only tested this on Windows. + +Currently it only works with the regular install, the .exe will not work. + + + +#Setup and Usage: +1. Install SHARK using the command line instructions found here: https://github.com/nod-ai/SHARK +2. Extract the Mori-Shark-Factory.zip file to some directory somewhere. +3. Run the app. +4. Pull the "Prompt" dropdown optiont to "Shark Install" [Like this]( https://github.com/Morichalion/Mori-Shark-Factory/blob/main/Shark-Location.png) +6. Enter the path. +7. Set the dropdown back to prompt. [Like this](https://github.com/Morichalion/Mori-Shark-Factory/blob/main/promps.png) +8. Enter your prompts +9. On the first run, SHARK will download the .vmbf files, so it'll take a bit. +10. Another quirk: the first time you generate a file the cmd window may not close on it's own. Close it and restart. +11. Have fun. + + +The output is set write to a directory on desktop (~\Desktop\Mori-Shark-Factory\sharkOutputs). The