====================================================================================
TROUBLESHOOTING GUIDE
====================================================================================

Key:
Q = Question
A = Answer

------------------------------------------------------------------------------------
INSTALLATION & RUNNING
------------------------------------------------------------------------------------

Q: My computer is asking me what to open this file with, what do I click?
A: Click "Python", it has a black background with a blue and yellow snake icon.

Q: How do I run this on Linux?
A: Navigate to where you have downloaded the file with the command "cd <folder name>".

To run:

- The Setup:
  'python3 Requirements_Setup.py'

- The List Generator:
  'python3 List-Gen.py'

- The main Script:
  'python3 main.py'

Q: The terminal doesn't seem to be doing anything, it's paused.
A: Don't type or click anything, this just means it is processing in the background.

------------------------------------------------------------------------------------
WARNINGS & LOGS (RED TEXT)
------------------------------------------------------------------------------------

Q: Red text appears at the top when I run it saying "[nltk_data] Downloading package brown to.."
A: Don't worry, this is normal behavior and is just Python loading the dictionary to generate passwords. This is not an error.

Q: Red text appears saying "DeprecationWarning: imghdr was removed in Python 3.13. Please be aware that you are currently NOT using standard 'imghdr', but instead a separately installed 'standard-imghdr'."
A: This is because the script uses an old module called imghdr which no longer exists. This is a standard warning letting you know you're using a separately downloaded version called "standard-imghdr" and it is not an error.

------------------------------------------------------------------------------------
PGP & KEY SETUP
------------------------------------------------------------------------------------

Q: I get a message saying "Your PGP Fingerprint is:" when I first run the program, what is this?
A: This is a unique ID for your PGP keypair (private.asc and public.asc files). It is only used if there is an error to ensure the key you gave your friend hasn't been changed since you gave it to them. Please note this down.

------------------------------------------------------------------------------------
ERRORS & CRASHES
------------------------------------------------------------------------------------

Q: The program crashes when I run it.
A: 
For Windows and Mac:
	Open it with IDLE (search IDLE on your system, press CTRL+O, and click main.py). Run it exactly how you did 	before, then copy and send me the error on Discord @starcrestmc or email me at admin@starcrestmc.net.

For Linux:
	Keep the terminal open after running it then copy and send me the error on Discord @starcrestmc or email me 	at admin@starcrestmc.net.

Q: I get the error "<friendsname>'s vault is corrupt, please regenerate"
A: This means the shared password list between you and your friend is either not the same as the other person's or is corrupt. Please delete the file, select option 2 to generate a new list, share it with that friend, then re-encrypt it with option 3.

Q: I get the error "Ciphertext is corrupt or Incorrect Sender was used!"
A: This means either the message your friend sent you isn't the entire message, or you selected the wrong person's PGP key or password list.

Q: I get the error "Message is corrupt or Incorrect PGP key used"
A: This means either your message is malformed, you selected the wrong PGP key, or your PGP key is corrupt. If it is corrupt, delete the PGP keys (private.asc and public.asc) and regenerate them by re-running the script.

------------------------------------------------------------------------------------
SUPPORT
------------------------------------------------------------------------------------

Is there a problem I have missed or haven't listed here? Contact me at admin@starcrestmc.net or via Discord at @starcrestmc and I will be happy to help!
