Merge pull request #48 from T342guy/{MAIN}-Release

pull all changes from MAIN to expr test, mostly README and other

Author: T342guy

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing 
+
+rules for contributing; 
+1. new fixes should allways go into experimental.
+2. no decrypting or leaking encrypted items. they are like that for a reason. this is punishable by a mute/ban
+3. sensitive codes/passwords should not be written in note or code. make a private note with the password and its hash used.
+4. please disble DEBUG before a MAIN push.
+
+
+this is a bit in WIP, may add more. 

README.md

@@ -1,34 +1,82 @@
+![github VAIIYA readme logo](https://github.com/user-attachments/assets/cd83c6e0-63b5-4449-b1ff-71d29c505de3)
+
+
+<div align="center">
+	<p>
+     <object>
+		<a href="https://discord.gg/Qt5Je9sFE5"><img alt="Discord" src="https://img.shields.io/discord/1279687931786694706?style=plastic&label=The%20VAIIYA%20Hub%20discord%20server!&link=https%3A%2F%2Fdiscord.gg%2FQt5Je9sFE5">
+     </object>
+	</p>
+</div>
+
+
 # Welcome to the VAIIYA terminal project page!
 
-Welcome to the VAIIYA Terminal project page!! 
-I am very happy to show you all my VAIIYA TERMINAL passion project! 
-the real purpose for this "game" was just an idea and a very far fetched idea that Embark Rob may collab with it ( I still think its far fetched but it is a good learning course! )
 
-and that i saw how much retro stuff (eg, the commandprompt credits screen for S2 and S3.) was used and i saw how VAIIYA would use somthing like that. 
+> [!IMPORTANT]
+> Notices about VAIIYA Termial will show up in this note! 
 
-also as a side note: this will be a very good experemantation for password protected encryption as the sourcecode is here on github. so dont be alarmed if there is some gobbleygook in the code :3 
+
+Welcome VAIIYA trustees and fellow THE FINALS contestants!
+welcome to my VAIIYA terminal project page! 
+
+VAIIYA terminal is a for-fun project made by me and serves mostly the purpose of being entertainment and a story module! 
+I hope you can join me on my long journey of making this dream come true with me! 
 
 
-( ps; rob if you read this, can i have the offical VAIIYA ASCII art for my code plz 🙏🥹 ) 
 
 # The game
-**IMPRORTANT NOTE: THE VAIIYA TERMINAL EXE's HAVE FLAGGED WINDOWS SMART APP CONTROLL DUE TO THE EXE's NOT BEING SIGNED. YOU CAN SAFELY IGNORE THESE WARNINGS.**
 
+> [!CAUTION]
+> **THE VAIIYA TERMINAL EXE's HAVE FLAGGED WINDOWS SMARTSCREEN CONTROL MOST LIKELY DUE TO THE EXE's NOT BEING SIGNED. YOU CAN SAFELY IGNORE THESE WARNINGS.**
+
+![image](https://github.com/user-attachments/assets/eb8b47da-1184-4fe8-b588-1e2154a52b9a)
+
+
+![image](https://github.com/user-attachments/assets/bb2aeea3-ec83-422d-9b64-7afd6e11009f)
+
+![image](https://github.com/user-attachments/assets/c2ffad7a-6e5e-4eff-a8dc-fbc543b17fb8)
+
+
+> [!NOTE]
+> all images were uploaded durring v10 or 0.0.10, things are subject to change!
+
+
+
+
+# Contributing 
 
-![image](https://github.com/user-attachments/assets/c8e9ee6f-d77e-455a-9e79-b1ce7b03953d)
+Hello fello VAIIYA Trustees! if you want to help with the progress of VAIIYA Terminal, here are some basic rules and things to know!  
 
+### Setup
 
+1. get Github desktop if you dont have it already :3  
 
-![image](https://github.com/user-attachments/assets/47f53723-933e-44ff-b5b4-26eec0598bc9)
+> [!IMPORTANT] 
+> Hello again everyone! just a quick edit, this note below is purely incorrect,
+> and i am working on a fix. In the meantime i will gather more info and fix this 
+> soon. Thank you for understanding.
+>
+>
+> *make sure you are using a **global** installation of python 3 for it to recognise the installed modules! if you use the "recommended" python3 installation from VScode, you will get errors of `reportMissingImports`!*  
+> get the latest release here: [python downloads](https://www.python.org/downloads/)
 
-all images were uploaded durring v7 or 0.0.7, things are subject to change! 
+2. Clone the repository and get dependencies 
+     - clone the repository with the HTTPS method through Github desktop 
+     - open the filestructure in VScode or your perferred IDE 
+     - install dependencies inside the filestructure with `pip install -r requirements.txt` 
+     - run `VAIIYA terminal.py` with the run button in VScode or your own IDE to see if everything is working! 
+  
+> [!TIP]
+> it is recommended that you install the pylance extension for VScode, as it has really nice fetures for debugging and other! 
 
 
+and thats all for setup! 
 
-# install dependencies 
+### Contributing rules 
 
-run this command in the file of the source or requirements.txt file.
+1. any new changes when being merged get sent to the experimental branch. 
+2. large changes **can** have their own branch, then will be merged to the experimental branch later on. 
 
-```
-pip install -r requirements.txt
-```
+> [!NOTE]
+> these contributing rules are still very scratched together for now, so a lot of self judgement will be applied for new rules to form.