docs(README.md): updated documentation

updated readme in documentation to initial version

Signed-off-by: Mythical-Github <MythicalData@gmail.com>

Author: Mythical-Github

README.md

@@ -0,0 +1,73 @@
+## UE4SS Installer GUI
+
+This is a gui installer/manager for [UE4SS](https://github.com/UE4SS-RE/RE-UE4SS).
+UE4SS consists of an injectable LUA scripting system, SDK generator, live property editor, other dumping utilities for UE4/5 games and more.
+
+
+### Download
+- Click [here](https://github.com/Mythical-Github/ue4ss_installer_gui/releases/latest) to be redirected to the latest prebuilt release.
+
+
+### Project Example:
+<img src="https://github.com/user-attachments/assets/b3716580-c31c-4691-8ec6-7c4299a9f83e" alt="example" width="50%" height="50%">
+
+  
+### Features:
+- Online/Offline support
+- Localization
+- Install
+- Uninstall
+- Install from zip
+- Supports windows/linux
+- Filterable version tag selection
+- Filterable release archive to install selection
+- Tags, and releases sorted by newest to latest
+- Open game executable directory in file browser button
+- Automatic game detection
+- Ability to provide extra directories to scan for games
+- Ability to add games manually
+- Handles multiple installs of one game
+- Portable install filter
+- Developer install filter
+- Prerelease install filter
+- Social buttons
+
+
+### Join the Discord
+If you have any problems, suggestions, or just want to chat, feel free to join the [Discord](https://discord.gg/7qhRGHF9Tt)
+
+
+### Suggestions
+If you have ideas or suggestions for the tool feel free to open a [suggestions issue](https://github.com/Mythical-Github/ue4ss_installer_gui/issues) or mention it in the discord.
+
+
+### Bug Reports
+If you encounter a bug or issue, please submit a report on the [issues page](https://github.com/Mythical-Github/ue4ss_installer_gui/issues). 
+When creating an issue, please provide as much information as possible, including:
+- Steps to reproduce the issue
+- What you expect to happen, versus what is happening
+- Any error messages or logs
+- Your system operating system
+
+
+### Contributing
+Contributions are always appreciated, but please keep in mind the following:
+- Before coding new features, try to make an issue to see if the idea/implementation needs any tweaking, or is out of scope
+- Please make sure all code submissions pass all pre-commit checks
+
+
+### Technologies:
+
+- **[DearPyGUI](https://github.com/Textualize/textual)** - Framework for creating TUI (Text User Interfaces) with Python.
+- **[Hatch](https://github.com/pypa/hatch)** - Modern project management tool for Python.
+- **[UV](https://github.com/astral-sh/uv)** - An extremely fast Python package and project manager, written in Rust.
+- **[PyInstaller](https://github.com/pyinstaller/pyinstaller)** - Tool to convert Python programs into standalone executables.
+- **[Ruff](https://github.com/astral-sh/ruff)** - Fast Python linter and code formatting tool.
+- **[PyProjectDevTools](https://github.com/Mythical-Github/py_project_dev_tools)** - A set of generic tools for Python applications, using Hatch, UV, and PyInstaller.
+- **[Pyright](https://github.com/microsoft/pyright)** - A fast type checker for Python.
+- **[Precommit](https://github.com/pre-commit/pre-commit)** - A framework for managing and maintaining multi-language pre-commit hooks.
+- **[Commitizen](https://github.com/commitizen-tools/commitizen)** - A tool to help you write consistent commit messages, and manage versioning.
+
+
+### License:
+[![license](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](LICENSE)

assets/base/assets/localization/en.json

@@ -9,7 +9,7 @@
   "enable_pre_releases_text_label": "Enable pre-releases",
   "game_directory_text_label": "Game Directory:",
   "github_button_text": "Github",
-  "header_text": "UE4SS",
+  "header_text": "UE4SS Installer",
   "install_button_text": "Install",
   "install_developer_version_text_label": "Install developer version (when applicable)",
   "install_failed_message_text": "The install failed",

assets/to_do_list.txt

@@ -1,6 +1,12 @@
 Next:
 
-# retest on linux
+# offline check removes social buttons
+# loading screen for scanning games
+# fix installs that only have ue4ss files
+# seems at times dupes for games can appear from the above as well right now
+# sometimes it doesn't properly remember the preferences of the checkboxes
+# sometimes the install button can be pressed, when no file to install is selected, prevent this somehow
+# bring back keep mods and settings and make uninstall more robust
 
 
 Later:

src/ue4ss_installer_gui/assets/localization/en.json

@@ -9,7 +9,7 @@
   "enable_pre_releases_text_label": "Enable pre-releases",
   "game_directory_text_label": "Game Directory:",
   "github_button_text": "Github",
-  "header_text": "UE4SS",
+  "header_text": "UE4SS Installer",
   "install_button_text": "Install",
   "install_developer_version_text_label": "Install developer version (when applicable)",
   "install_failed_message_text": "The install failed",

src/ue4ss_installer_gui/checks/online_check.py

@@ -0,0 +1,13 @@
+import socket
+
+
+is_online = False
+
+
+def init_is_online(timeout: float = 1):
+    global is_online
+    try:
+        socket.create_connection(("8.8.8.8", 53), timeout=timeout)
+        is_online = True
+    except (socket.timeout, OSError):
+        is_online = False

src/ue4ss_installer_gui/initialization.py

@@ -2,14 +2,18 @@
 import asyncio
 
 from ue4ss_installer_gui import ue4ss, settings, translator, logger, file_io
+from ue4ss_installer_gui.checks import online_check
 
 
 def init():
+    online_check.init_is_online()
+    print(f'Is online: {online_check.is_online}')
     logger.set_log_base_dir(os.path.normpath(f"{file_io.SCRIPT_DIR}/logs"))
     logger.configure_logging()
     settings.init_settings()
     translator.init_translator()
-    asyncio.run(auto_fetch_tags_on_start())
+    if online_check.is_online:
+        asyncio.run(auto_fetch_tags_on_start())
     asyncio.run(auto_scan_dirs())
 
 

src/ue4ss_installer_gui/main.py

@@ -1,7 +1,7 @@
 import os
 import dearpygui.dearpygui as dpg
 
-from ue4ss_installer_gui.screens import main_screen as main_screen
+from ue4ss_installer_gui.screens import main_screen
 from ue4ss_installer_gui import file_io, constants, settings, initialization
 
 
@@ -54,6 +54,7 @@ def main():
     dpg.set_viewport_large_icon(icon_path)
 
     main_screen.push_main_screen()
+
     dpg.set_viewport_pos([constants.X, constants.Y])
     dpg.setup_dearpygui()
     dpg.set_primary_window("main_window", True)