- v0.5.0 pre-release commit.

- Changes to method docs.
- Updated all instances of "VBP" to "VBPatcher".

Signed-off-by: schlopp96 <[email protected]>

Author: schlopp96

README.md

@@ -1,12 +1,12 @@
-# VBP
+# VBPatcher
 
 > Valheim BepInEx Patcher
 
 ---
 
 ## About
 
-- The Valheim BepInEx Patcher _**(VBP)**_ is a personal script created to solve the weird automatic version downgrading of the BepInEx modding tool.
+- The Valheim BepInEx Patcher _**(VBPatcher)**_ is a personal script created to solve the weird automatic version downgrading of the BepInEx modding tool.
 
 - For me, this is generally caused by the Vortex mod manager automatically downloading what it perceives to be the "necessary" files for modding.
 
@@ -16,17 +16,17 @@
 
 ### Using PIP _(Recommended)_
 
-- To install VBP using `pip`, enter the following:
+- To install VBPatcher using `pip`, enter the following:
 
   ```python
   pip --user install VBPatcher
   ```
 
 ### Manual Installation _(**NOT** Recommended)_
 
-1. Download the project from [GitHub](https://github.com/schlopp96/VBP) and extract to location of choice.
+1. Download the project from [GitHub](https://github.com/schlopp96/VBPatcher) and extract to location of choice.
 
-2. Open terminal and navigate to the extracted directory `"./path/to/VBP"`.
+2. Open terminal and navigate to the extracted directory `"./path/to/VBPatcher"`.
 
 3. Use `pip install -r requirements.txt` to install necessary dependencies.
 
@@ -40,7 +40,7 @@
 
 - Each time your modding tool is opened to edit Valheim, your files will be downgraded again, so **you must run this script every time before playing!**
 
-1. Open the script, which can be found inside the downloaded folder here: "VBP/src/patcher.py":
+1. Open the script, which can be found inside the downloaded folder here: "VBPatcher/src/patcher.py":
 
 2. Once the script is run, you will be prompted to choose whether to install the latest available build, the latest available stable version of BepInEx patch, or _both_ to ensure the latest possible build available.
 
@@ -65,7 +65,7 @@
   - **_Note that you can also find the latest bleeding-edge-builds of BepInEx [here](https://builds.bepis.io/projects/bepinex_be)._**
 
   ```python
-    >>> from VBP import vbp
+    >>> from VBPatcher import vbp
     >>> vbp()
     Welcome to the Valheim Bepinex Patcher!
 
@@ -138,4 +138,4 @@
 
 - If you have any questions, comments, issues, complaints, etc, feel free to contact me through my:
   - Email at: `[email protected]`.
-  - Submit an issue on the project's [GitHub repository](https://github.com/schlopp96/VBP)
+  - Submit an issue on the project's [GitHub repository](https://github.com/schlopp96/VBPatcher)

VBPatcher/main.py

@@ -1,9 +1,5 @@
 #!/usr/bin/env python3
-#@ ====================================================================================================== @#
-#> Valheim BepInEx Patcher <#
-#< Est. 10/24/21 >#
-#@ ====================================================================================================== @#
-#$ ====================================================================================================== $#
+
 import logging
 from datetime import datetime
 from os import chdir
@@ -31,7 +27,8 @@
 
 #* Establish Logger:
 class vbp_Logger():
-    """Generater for application logging.
+    """Generates application loggers.
+
     - Uses built-in Python `logging` module.
     """
     def __init__(self, log_file: str, log_format: str = '[%(asctime)s - %(levelname)s] : %(message)s'):
@@ -109,8 +106,11 @@ def vbp() -> None | NoReturn:
 def stable_patch() -> None | NoReturn:
     """Install latest BepInEx stable-build patch version to local directory.
 
-    :return: Installs BepInEx patch.
-    :rtype: None
+    ---
+
+    Parameters:
+        :return: Installs BepInEx patch.
+        :rtype: None
     """
     while True:
         logger.info(f'Displaying confirmation prompt to install BepInEx stable-release {b_stable} patch...')
@@ -135,8 +135,11 @@ def stable_patch() -> None | NoReturn:
 def BE_patch() -> None | NoReturn:
     """Install latest BepInEx bleeding-edge patch version to local directory.
 
-    :return: Install bleeding-edge patch to BepInEx directory.
-    :rtype: None
+    ---
+
+    Parameters:
+        :return: Install bleeding-edge patch to BepInEx directory.
+        :rtype: None
     """
     while True:
         logger.info(f'Displaying confirmation prompt to install BepInEx bleeding-edge build {b_latest} patch...')
@@ -161,8 +164,11 @@ def BE_patch() -> None | NoReturn:
 def full_patch() -> None | bool:
     """Install both available BepInEx patches in order of release (Stable -> Bleeding-Edge).
 
-    :return: Install both stable and bleeding edge patch builds in order of release to BepInEx directory.
-    :rtype: None
+    ---
+
+    Parameters:
+        :return: Install both stable and bleeding edge patch builds in order of release to BepInEx directory.
+        :rtype: None
     """
     while True:
         logger.info('Displaying confirmation prompt to install full-upgrade patch (install both stable and bleeding-edge builds in order of release)...')
@@ -188,8 +194,11 @@ def full_patch() -> None | bool:
 def promptStart() -> NoReturn | None:
     """Prompt user to choose whether or not to start the game post-patch.
 
-    :return: Exits program or starts game.
-    :rtype: NoReturn | None
+    ---
+
+    Parameters:
+        :return: Exits program or starts game.
+        :rtype: NoReturn | None
     """
     while True:
         logger.info('Displaying start game prompt...')
@@ -216,8 +225,13 @@ def openValheim() -> int | None:
     - Will raise `TimeoutExpired` exception if executable doesn't start within 10 seconds.
         - Prevents program from freezing due to any errors encountered during launch process.
 
-    :return: Start game client.
-    :rtype: int | None
+    - Steam must be running to properly initialize launch process.
+
+    ---
+
+    Parameters:
+        :return: Start game client.
+        :rtype: int | None
     """
     try:
         logger.info('Starting Valheim...\n\n')
@@ -230,7 +244,11 @@ def openValheim() -> int | None:
 
 
 def patch(patchDir: Any, targetDir: Any, ver: Any) -> None:
-    """Apply `patchDir` to `targetDir`.
+    """Apply `patchDir` files to `targetDir` directory.
+
+    - Will overwrite existing files.
+
+    ---
 
     Parameters:
         :param patchDir: Directory containing patch files.
@@ -256,8 +274,11 @@ def patch(patchDir: Any, targetDir: Any, ver: Any) -> None:
 def exitPatcher() -> None | NoReturn:
     """Exit the application and finalize log.
 
-    :return: Exits application.
-    :rtype: None | NoReturn
+    ---
+
+    Parameters:
+        :return: Exits application.
+        :rtype: None | NoReturn
     """
     logger.info(f'Exiting patcher...\n\n==> End of log...\n\n\n{_textborder}\n\n')
     return ex()

setup.py

@@ -9,8 +9,8 @@
     name='VBPatcher',
     version="0.5.0",
     description=
-    'The Valheim BepInEx Patcher (VBP) is a personal script created to solve the weird automatic version downgrading of the BepInEx modding tool.',
-    url='https://github.com/schlopp96/VBP',
+    'The Valheim BepInEx Patcher (VBPatcher) is a personal script created to solve the weird automatic version downgrading of the BepInEx modding tool.',
+    url='https://github.com/schlopp96/VBPatcher',
     author='schlopp96',
     author_email='[email protected]',
     license='GPL v3.0',