LinuxGSM

6794 Commits

18 Branches

170 Tags

47 MiB

Tree: b346e68fd5

Commit Graph

Author	SHA1	Message	Date
Daniel Gibbs	fef128fb7d	fix (alerts): Alerts on update uses the old game server version not the new one (#4854 ) * feat: refactor update comparison output for consistency and clarity - Replaced direct echo statements with fn_print functions for uniformity in output formatting across multiple update scripts. - Ensured lockfile creation uses the correct syntax for variable expansion. - Moved lock file to the same location to ensure monitor doesnt reboot at the wrong time - Updated remote build information display to enhance readability and maintain consistency in logging. - Removed unnecessary echo commands to streamline the output process. * Refactor remote build version handling across multiple modules - Updated variable names from 'remotebuildversion' to 'remotebuild' for consistency. - Adjusted logic to check for remote build availability using the new variable name. - Modified output messages to reflect the change in variable naming. - Ensured all modules (update_mc.sh, update_mcb.sh, update_mta.sh, update_pmc.sh, update_ts3.sh, update_ut99.sh, update_vints.sh, update_xnt.sh) are aligned with the new naming convention for better readability and maintainability. * fix(alert): resolve issue with servername not always being listed in title * Moved `info_distro.sh`, `info_game.sh`, and `info_messages.sh` calls to the top of the `fn_alert_log` function for better clarity. * Updated `alerticon` assignment to maintain consistency in alert information handling. * fix(alert_discord): remove "More info" field from Discord alert JSON * Eliminated the "More info" field to streamline the alert message. * This change enhances the clarity of the alert by focusing on essential information. * fix(alert): improve update alert messaging for clarity * Updated alert messages in `fn_alert_update` and `fn_alert_update_failed` for better readability. * Changed alert action from `update-request` to `update-restart-request` in `fn_monitor_check_update_source`. * remove inline * fix(alert): Correct grammar in update alert message * Changed "an LinuxGSM update" to "a LinuxGSM update" for grammatical accuracy. * typo * fix(alert_discord): Add inline property to "Is my Game Server Online?" field * Ensures proper formatting of the Discord alert message. * Improves the display of the server status information. * fix(pd): increase timeout for termbin.com connection * fix(alert_discord): reorder fields in Discord alert JSON * Changed the order of fields in the Discord alert JSON structure. * Updated the "More info" and "Is my Game Server Online?" fields for better clarity. * revert back to factorio.com Co-authored-by: Copilot <[email protected]> * Standardizes alert messages across platforms Ensures consistency in alert messages across Discord, NTFY, Pushover, Rocketchat, Slack, and Telegram. Updates Discord alerts to include server hostname and time, removes redundant formatting. Standardizes plain-text alert formatting for NTFY. Refactors Pushover messages to use consistent HTML formatting. Streamlines Rocketchat and Slack messages by removing duplicate server info and adding optional link support. * Removes Hostname from alert messages Removes the Hostname field from various alert messages (Discord, Gotify, IFTTT, ntfy, Pushbullet, Pushover, Rocketchat, Slack, Telegram). The hostname was deemed redundant or unnecessary in the context of these alerts. Relates to #4696 * Configures shellcheckrc filename Configures the Super-Linter action to use `.shellcheckrc` as the BASH_FILE_NAME. This ensures that shellcheck uses the correct configuration file for bash script linting. Fixes #4696 * Disables shellcheck errors and removes variable Disables specific shellcheck errors to allow certain coding patterns and removes an unused variable from the super-linter workflow. This improves the linter's signal-to-noise ratio and reduces unnecessary checks. Relates to #4696 * Fixes and improves server list validation scripts Addresses issues in the server list validation scripts: - Fixes potential issues with parsing curl custom arguments in telegram alerts. - Corrects the shortname array generation. - Implements more robust checks for validating game icons. - Ensures the consistency of server counts across different CSV files. * Fixes glibc check and mod selection logic Corrects glibc version comparison to properly handle version strings. Improves mod installation and removal by validating user input against available options, providing a more robust selection process. This prevents errors caused by invalid mod names and enhances the user experience. Updates arithmetic expression syntax for better compatibility. * Fixes cache control for dev-debug mode Updates the handling of cache control headers in dev-debug mode. The `nocache` variable is changed to an array to correctly pass multiple headers to `curl`. This resolves issues with cached versions of files being used when dev-debug is enabled, ensuring that the latest versions are always fetched. Fixes #4696 * Allows spaces in steamcmdcommand variable Parses steamcmdcommand as an array to allow spaces in the variable. This prevents issues when the user wants to pass arguments with spaces to the steamcmd executable. * Addresses various script improvements Addresses multiple improvements across various scripts: - Fixes Valheim unstripped_corlib override by commenting out the lines in the config files. - Improves process identification for source and goldsrc engines using `pgrep`. - Enhances backup file identification using `find` with `-maxdepth 1` and `-type f`. - Fixes glibc version comparison logic in multiple files. - Improves UT2K4 key installation script by using printf for writing the key to the file. - Corrects the mod info extraction logic to correctly identify mod entries. - Improves amxmodx file installation/removal logic to prevent duplicate entries. - Fixes server info retrieval to handle spaces in the server list. Relates to #4696 * Fixes mono repo install exit code check Corrects the mono repo install exit code check to use the dedicated monorepoexitcode variable, ensuring accurate error detection. Updates the exit trap to preserve the original exit status, preventing potential loss of information when handling script termination. * Refactors and reorders core modules Improves module loading by reordering and refactoring the core modules. This change addresses inconsistencies and improves the overall structure of how core modules are handled within the system. Some fix scripts were renamed to match the module name. * Makes scripts executable Changes file permissions to make shell scripts executable. This ensures that the scripts can be run directly. Addresses a pre-existing issue. Related to #4696 * Adds explicit permissions to workflows Specifies explicit permissions for GitHub Actions workflows to enhance security and control access to resources. This ensures that each workflow only has the necessary permissions, following the principle of least privilege. * Fixes output redirection and URL parsing Corrects output redirection in GitHub Actions workflows by enclosing the $GITHUB_OUTPUT variable in quotes, preventing potential issues with variable expansion. Ensures proper URL parsing in workflows by enclosing the URL within quotes, addressing potential parsing errors. Fixes #4696 * Applies code formatting for consistency Applies Prettier formatting to the codebase for improved readability and consistency. Addresses minor code style inconsistencies across several files. * Fixes minor formatting and logic issues Addresses various minor issues including: - Standardizes indentation in `.editorconfig` for different file types. - Simplifies Prettier configuration. - Updates image links in `README.md`. - Ensures newline character at end of `.csv` files. - Corrects a conditional statement in `command_fastdl.sh`. - Corrects a conditional statement in `info_messages.sh`. - Updates server query protocols in `query_gsquery.py`. * Configures and disables linters Adds YAML linting configuration and disables unnecessary linters to streamline the CI/CD process and reduce noise from irrelevant checks. * Improves documentation and linting Updates documentation links to be enclosed in angle brackets, preventing markdown rendering issues. Configures markdownlint to align with repository standards and avoid common false positives. The updated links in the documentation ensure they are correctly interpreted by markdown parsers, improving user experience. The markdownlint configuration fine-tunes linting rules to better match the project's existing style and conventions, reducing noise from irrelevant warnings. * Fixes typos and improves code consistency Addresses various typos and inconsistencies across multiple files, enhancing code readability and maintainability. Adds codespell and flake8 configurations for linting. Relates to #4696 * Excludes workflow files from Prettier formatting Prevents Prettier from formatting workflow files due to GitHub token restrictions, as the token used by the Prettier auto-commit action lacks permissions to update files within the `.github/workflows/` directory. * chore(prettier): format code * Updates Super-Linter configuration Improves Super-Linter's reliability by switching to linting the entire codebase instead of relying on git history. This change also addresses potential transient fetch failures from GitHub. Additionally, this commit expands the ignored paths in codespell and disables some linters to improve performance and reduce false positives. --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: dgibbs64 <[email protected]>	3 months ago
Daniel Gibbs	ee20e18be3	feat: User interface refactor (#4716 ) * refactor: improve log directory creation - Changed the variable `checklogs` from being set to `1` to being set to `true`. - Improved the logic for creating log directories and files. - Added more informative console output for each step of the process. - Refactored code to use conditional statements instead of nested if statements. - Removed unnecessary print statements. This commit improves the way log directories are created and handles cases where logs already exist. It also provides clearer console output during the process. * refactor: improve console output formatting - Added color support for console output using tput commands - Updated print functions to display formatted messages with colors and bold text * refactor: improve console log creation The code in `install_logs.sh` has been refactored to improve the creation of the console log. The commit removes unnecessary whitespace and updates the echo statement to provide a more concise output. * a * refactor: improve log directory creation messages - Changed the format of log directory creation messages to include parentheses around the directory path. - Updated the messages in `install_logs.sh` file to reflect this change. * refactor: improve log directory symlink creation The code has been refactored to improve the creation of symlinks for game log directories. The commit removes unnecessary echo statements and updates the output format to provide clearer information about the created symlinks. * feat: create server directory - Updated the script to create a server directory - Removed unnecessary check for existing server directory * refactor: improve console output for fetching files The commit refactors the code in `install_server_dir.sh` and `linuxgsm.sh` to improve the console output when fetching files. The message now includes more descriptive information about the file being fetched, such as the source URL and local filename. Additionally, the success message has been updated to include brackets around "OK" for better readability. * refactor: improve formatting of success message The success message in the core_messages.sh file has been updated to include square brackets around "OK" for better visibility. * ui * refactor: improve console output for checking and fetching files - Updated the console output in `command_update_linuxgsm.sh` to include formatting and improved readability. - Improved the console output in `core_dl.sh` to include formatting and better indicate the progress of file fetching. * refactor: improve logging message in fn_fetch_file The logging message in the fn_fetch_file function has been improved to provide a more concise and informative output. Instead of mentioning the local filename separately, it is now included within the same line as the file URL name. This change enhances readability and clarity when fetching files. * refactor: improve console output in core_dl.sh and linuxgsm.sh - Refactored code to improve the console output in core_dl.sh and linuxgsm.sh. - Updated echo statements to provide more informative messages. - Removed unnecessary characters from the console output. * refactor: improve code readability and remove unnecessary comments The commit message summarizes the changes made to the code. In this case, the code has been refactored to improve its readability and remove unnecessary comments. * refactor: improve readability and consistency in code - Refactored echo statements to provide more informative messages. - Renamed variables for better clarity. - Removed unnecessary comments and unused code. * refactor: improve logging message in core_dl.sh The logging message in the `fn_fetch_file` function has been updated to provide a more concise and informative description of the file being fetched. * refactor(core_messages): update print functions - Updated the print functions in the core_messages.sh file to improve readability and consistency. - Replaced the use of "tputreset" with "${default}" for better code clarity. - Modified the formatting of the output messages to follow a consistent pattern. - Removed unnecessary escape sequences from the echo statements. * refactor: improve header and server directory installation messages - Updated ASCII logo formatting for better visibility. - Added emphasis to the LinuxGSM name in the header message. - Changed the contributor and sponsor links to be more descriptive. - Modified the server directory installation message to indicate if a game server already exists at the specified location. * refactor: improve log directory creation messages - Changed the log directory creation messages to include square brackets around the directory paths. - Updated the console log and game log directory creation messages to use square brackets as well. - Modified the symlink creation messages for game logs and Steam logs to also include square brackets. This commit improves the readability of the log directory creation process by adding square brackets around the relevant paths. * refactor: improve log directory creation and server directory installation - Change log directory creation message to use bold font for emphasis. - Update symlink creation message to clarify that it is creating a symlink to the game log directory. - Add a check to skip creating a symlink if it already exists for the Steam log directory. - Change server directory installation message to use bold font for emphasis. * refactor: improve log directory symlink creation This commit refactors the code in `install_logs.sh` to improve the creation of symlinks for game log directories. The commit fixes a typo in the echo statement and updates the symlink paths for both game logs and Steam logs. * feat: create serverfiles directory - Updated the message to indicate that a serverfiles directory is being created - Improved clarity and readability of the code * refactor: improve consistency and readability of print functions - Refactored the print functions in the core_messages.sh file to improve consistency and readability. - Updated the output format by adding ellipsis (...) before each status message for better visual separation. - Replaced hard-coded color codes with variables for easier maintenance. Co-authored-by: AI Assistant <[email protected]> * refactor: improve readability of code in command_update_linuxgsm.sh - Replaced "checking" with "checking [filename]" for better clarity - Changed echo statements to use fn_print_update_eol_nl instead of fn_print_ok_eol_nl - Updated comments for better understanding of the code flow * refactor: improve logging and error handling in command_update_linuxgsm.sh - Refactored log messages for better clarity and readability. - Improved error handling by checking the return value of curl command. - Updated backup location log message to include brackets. * refactor: simplify code for checking file differences The commit simplifies the code for checking file differences in the `command_update_linuxgsm.sh` script. It replaces the function `fn_print_ok_eol_nl` with `fn_print_skip_eol_nl` to improve readability and maintainability. * refactor: improve print message in command_update_linuxgsm.sh The code change refactors the print message in the command_update_linuxgsm.sh file. Instead of printing "OK", it now prints "SKIP" to indicate that a module is being removed. This improves clarity and consistency in the script's output. * skip * refactor: improve readability and add emphasis to file names in code - Refactored code to improve readability and maintainability. - Added emphasis to file names by using italics. - Updated echo statements to reflect the changes. * feat: improve fetch file output - Updated the fetch file function in core_dl.sh and linuxgsm.sh to provide more informative output. - Replaced the parentheses with square brackets to enclose the local filename. - Added italics formatting to highlight the local filename. * feat: improve log directory creation - Updated log directory creation to include italic formatting for directory names. - Added italic formatting for script log, console log, game log, and steam log directories. - Improved serverfiles directory creation by including italic formatting for the directory name. * refactor: improve readability and consistency in code - Updated the echo statement to include formatting for script name - Added bold formatting to EULA acceptance message - Removed unnecessary line breaks and added italic formatting to EULA URL - Refactored code to remove duplicate calls to install_eula.sh * feat: add new line before Y/N prompt The commit adds a new line before the Y/N prompt in the `fn_prompt_yn` function. This improves readability and user experience. refactor: improve formatting in install_server_files.sh The commit improves the formatting in the `install_server_files.sh` file by adding bold styling to the installation header. It also adds bold styling to the separator line for better visual separation. These changes enhance the overall appearance of the installation process. fix: correct formatting issue in install_server_files.sh The commit fixes a formatting issue in the `install_server_files.sh` file where an extra separator line was not properly formatted with bold styling. The fix ensures consistent and correct formatting throughout the script. chore: update prompt message in install_server_files.sh The commit updates a prompt message in the `install_server_files.sh` file to make it more informative and user-friendly. The updated message asks if the installation was successful, providing clearer instructions for users. refactor: remove redundant separator line in install_server_files.sh The commit removes a redundant separator line from the `install_server_files.sh` file that was causing unnecessary visual clutter. This improves code readability and simplifies the installation process. * changes * refactor: improve logging and error handling in install_config.sh - Refactored the code to use more descriptive function names. - Improved logging by using fn_print_ok_eol and fn_print_failure_eol functions. - Added error handling for copying config files, displaying failure messages if necessary. - Updated comments for better clarity. * refactor: improve logging and remove unnecessary code - Changed `fn_print_failure_eol` to `fn_print_fail_eol` for consistency. - Removed redundant log messages and sleep time. - Simplified the logic for changing hostname and rcon/admin password. - Removed warning message when config file is not found. Co-authored-by: AI Assistant <[email protected]> * refactor: update server names in default configuration files - Updated the servername value in multiple default configuration files to "LinuxGSM" for consistency. - Refactored the code to reflect the changes made. This commit refactors the default configuration files for various game servers by updating the servername value to "LinuxGSM". This change ensures consistency across different game servers. * refactor: remove unused code and files This commit removes unused code and files from the project. The deleted files include default configuration files and test scripts that are no longer needed. * refactor: improve readability and error handling in install_config.sh - Refactored the code to improve readability by adding bold formatting to console output. - Improved error handling by using the exit status of commands instead of a separate variable. - Replaced repetitive sleep calls with fn_sleep_time function. - Updated log messages for clarity and consistency. - Added conditional checks for successful file copying and printing appropriate status messages. Co-authored-by: AI Assistant <[email protected]> * refactor: simplify config file copying and error handling This commit simplifies the code for copying default config files from the Game-Server-Configs repository to the server's config location. It also improves error handling by printing appropriate messages and logging them. * misc changes * reword of dst config install Removed install settings as it complicates setup. The admin how has to manually setup a slave shard using configs. By default LinuxGSM will setup a Master shard. Docs will need to be updated. * refactor: improve config location listing - Renamed the function `fn_list_config_locations` to better reflect its purpose. - Updated the output messages to provide clearer information about the config locations. - Added formatting enhancements for better readability. This commit refactors the code related to listing config locations, making it more user-friendly and informative. * ui changes * refactor: improve code readability and fix typos - Refactored the code to improve readability and organization. - Fixed typos in the comments and echo statements. - Changed some echo statements to use variables for better consistency. - Updated URLs in the echo statements to be clickable links. Co-authored-by: [co-author name] * ui changes * ui changes * fix: update warning message for missing SteamCMD The commit updates the warning message in the code to indicate that SteamCMD is not installed instead of being missing. Additionally, it modifies the log message accordingly. * refactor: simplify directory creation in install_config.sh This commit simplifies the code for creating config directories in the install_config.sh file. Instead of using separate variables for each directory path, it now uses a single variable to create the necessary directories. This improves readability and reduces redundancy in the code. * feat: add installation and information for SteamCMD - Added code to install SteamCMD if it is missing or the steamcmd directory is missing. - Modified the check_steamcmd function to print a warning message if SteamCMD is not installed. - Modified the info_game_dst function to retrieve additional information from server and cluster configuration files. - Updated the installation script to display a bold header before installing SteamCMD. * refactor: improve error message in install_config.sh The commit refactors the code in `install_config.sh` to improve the error message when copying a config file. The function `fn_print_failure_eol_nl` is renamed to `fn_print_fail_eol_nl` for clarity and consistency. This change enhances the readability and maintainability of the code. * refactor: improve conditional statements in install_config.sh The code changes refactor the conditional statements in the `install_config.sh` file. Instead of checking if `${shortname}` is equal to "dst" or "arma3", it now checks if `${clustercfgdir}` or `${networkcfgdir}` are not empty, respectively. This improves readability and maintainability of the code. a * refactor: simplify config directory creation and copying The code changes simplify the logic for creating config directories and copying config files. The function `fn_check_cfgdir` now only creates the server config directory if it exists, removing unnecessary checks for other directories. Additionally, the function `fn_default_config_remote` no longer duplicates the call to `fn_check_cfgdir`. * refactor: improve variable naming and remove unnecessary code duplication The commit refactors the code in `install_config.sh` to improve variable naming and remove unnecessary code duplication. Specifically, it renames the variables for better clarity and removes redundant lines of code. refactor: improve installation and configuration process - Refactored the fix_dst.sh script to keep the shard name in server.ini consistent with the LinuxGSM config. - Updated install_config.sh to provide clearer messages during the default config download and copy processes. refactor: update shard name in server.ini The code has been refactored to update the shard name in the server.ini file. This change ensures that the shard name in the LinuxGSM config matches the one in server.ini. * feat: improve console output formatting - Added separator function to improve readability of console output. - Replaced multiple instances of manual separators with the new function. - Updated commit message to follow conventional commit standard. * refactor: remove unnecessary fn_sleep_time calls This commit removes the fn_sleep_time function calls that are no longer needed in multiple modules. The fn_sleep_time function was used to introduce a delay, but it is no longer necessary for the current implementation. * refactor: remove unused functions This commit removes a large number of unused functions from the core_functions.sh module. These functions were not being called or used anywhere in the codebase and were therefore unnecessary. Removing them helps to clean up the code and improve maintainability. * refactor: improve consistency and readability of code - Changed the color of "Missing Server Details" to bold yellow - Changed the color of "Query IP Addresses" to bold yellow - Changed the color of "Game Server Ports" to bold yellow - Changed the color of "SS Output" to bold yellow - Changed the color of "Query Port - Raw Output" to bold yellow - Changed the color of "Gamedig Raw Output" to bold yellow - Changed the color of "gsquery Raw Output" to bold yellow - Changed the color of "TCP Raw Output" to bold yellow - Changed the color of "Game Port - Raw Output" to bold yellow - Changed the color of "Steam Master Server Response" to bold yellow - Updated commit message formatting for better readability * refactor: improve code readability and efficiency in command_dev_query_raw.sh - Simplify conditionals by replacing [ -v var ] with [ -n "${var}" ] - Remove unnecessary checks for the presence of jq and gamedig - Update output headers to be more descriptive and consistent - Use italic formatting for curl command in Steam Master Server Response section * refactor: improve query output formatting The code changes refactor the query output formatting in the command_dev_query_raw.sh file. The changes include: - Adding italics to certain command outputs for better readability - Removing unnecessary echo statements - Updating comments and indentation for clarity * refactor: simplify storage information display The code in `info_messages.sh` has been refactored to improve the readability and conciseness of the storage information display. The labels for total and used space have been shortened to "Total" and "Used" respectively. * refactor: renamed fatal to fail to improve consistency - Updated the log level from "fatal" to "fail" in the alert scripts. * feat: add conditional printing of alert messages This commit adds conditional statements to only print alert messages if the corresponding alerts are turned on. This improves the readability of the output by only displaying relevant information. - Added conditionals for Discord, Email, Gotify, IFTTT, Pushbullet, Pushover, Rocketchat, Slack, and Telegram alerts - Only prints alert messages if the corresponding alerts are turned on * feat: improve console and post details commands - Updated the console command to display a link in italics to the documentation. - Updated the post details command to display the URL in italics for support. - Renamed "Donation options" to "Sponsorship options" in the sponsor command. - Added Minecraft as an example of a game with query enabled in info messages. Closes #123 * quit * update fn_bootstrap_fetch_file * ui changes * bootstrap trap * ui updates * att bootstrap fetch module * ui updates * bug * merge 2 functions * ui changes * config ui changes * installer ui changes * installer ui changes * add fn_print and fn_print_nl * remove space * add new dev command ui * bug * skip to light blue * update to light blue * reset to default * update ui changes * steamui changes * print * fix * sleep time * validate * remote location * italic url * fastdl * fn_print * fix * ui * speed up * fastdl ui * ui fix * ui fix * update some headers * header updates * minor changes * install changes * messages refactor * ui changes * bug * standardise exitcode * tidy * bug * bug * revert * updating dev ui * ui changes * bug * skip * bug * change minimum required message * fix incorrect var name * ui updates * remove ) from results * revert * ensure command action capitals are consistant * revert * revert * revert * codacy * revert * revert --------- Co-authored-by: AI Assistant <[email protected]> Co-authored-by: AI Assistant <[email protected]>	2 years ago

Author

SHA1

Message

Date

Daniel Gibbs

fef128fb7d

fix (alerts): Alerts on update uses the old game server version not the new one (#4854 )

* feat: refactor update comparison output for consistency and clarity

- Replaced direct echo statements with fn_print functions for uniformity in output formatting across multiple update scripts.
- Ensured lockfile creation uses the correct syntax for variable expansion.
- Moved lock file to the same location to ensure monitor doesnt reboot at the wrong time
- Updated remote build information display to enhance readability and maintain consistency in logging.
- Removed unnecessary echo commands to streamline the output process.

* Refactor remote build version handling across multiple modules

- Updated variable names from 'remotebuildversion' to 'remotebuild' for consistency.
- Adjusted logic to check for remote build availability using the new variable name.
- Modified output messages to reflect the change in variable naming.
- Ensured all modules (update_mc.sh, update_mcb.sh, update_mta.sh, update_pmc.sh, update_ts3.sh, update_ut99.sh, update_vints.sh, update_xnt.sh) are aligned with the new naming convention for better readability and maintainability.

* fix(alert): resolve issue with servername not always being listed in title

* Moved `info_distro.sh`, `info_game.sh`, and `info_messages.sh` calls to the top of the `fn_alert_log` function for better clarity.
* Updated `alerticon` assignment to maintain consistency in alert information handling.

* fix(alert_discord): remove "More info" field from Discord alert JSON

* Eliminated the "More info" field to streamline the alert message.
* This change enhances the clarity of the alert by focusing on essential information.

* fix(alert): improve update alert messaging for clarity

* Updated alert messages in `fn_alert_update` and `fn_alert_update_failed` for better readability.
* Changed alert action from `update-request` to `update-restart-request` in `fn_monitor_check_update_source`.

* remove inline

* fix(alert): Correct grammar in update alert message

* Changed "an LinuxGSM update" to "a LinuxGSM update" for grammatical accuracy.

* typo

* fix(alert_discord): Add inline property to "Is my Game Server Online?" field

* Ensures proper formatting of the Discord alert message.
* Improves the display of the server status information.

* fix(pd): increase timeout for termbin.com connection

* fix(alert_discord): reorder fields in Discord alert JSON

* Changed the order of fields in the Discord alert JSON structure.
* Updated the "More info" and "Is my Game Server Online?" fields for better clarity.

* revert back to factorio.com

Co-authored-by: Copilot <[email protected]>

* Standardizes alert messages across platforms

Ensures consistency in alert messages across Discord, NTFY,
Pushover, Rocketchat, Slack, and Telegram.

Updates Discord alerts to include server hostname and time,
removes redundant formatting.

Standardizes plain-text alert formatting for NTFY.

Refactors Pushover messages to use consistent HTML formatting.

Streamlines Rocketchat and Slack messages by removing duplicate
server info and adding optional link support.

* Removes Hostname from alert messages

Removes the Hostname field from various alert messages (Discord, Gotify, IFTTT, ntfy, Pushbullet, Pushover, Rocketchat, Slack, Telegram).

The hostname was deemed redundant or unnecessary in the context of these alerts.

Relates to #4696

* Configures shellcheckrc filename

Configures the Super-Linter action to use `.shellcheckrc` as the
BASH_FILE_NAME. This ensures that shellcheck uses the correct
configuration file for bash script linting.

Fixes #4696

* Disables shellcheck errors and removes variable

Disables specific shellcheck errors to allow certain coding
patterns and removes an unused variable from the super-linter
workflow. This improves the linter's signal-to-noise ratio
and reduces unnecessary checks.

Relates to #4696

* Fixes and improves server list validation scripts

Addresses issues in the server list validation scripts:

- Fixes potential issues with parsing curl custom arguments in telegram alerts.
- Corrects the shortname array generation.
- Implements more robust checks for validating game icons.
- Ensures the consistency of server counts across different CSV files.

* Fixes glibc check and mod selection logic

Corrects glibc version comparison to properly handle version strings.

Improves mod installation and removal by validating user input
against available options, providing a more robust selection process.
This prevents errors caused by invalid mod names and enhances the
user experience.

Updates arithmetic expression syntax for better compatibility.

* Fixes cache control for dev-debug mode

Updates the handling of cache control headers in dev-debug mode.
The `nocache` variable is changed to an array to correctly pass multiple headers to `curl`.
This resolves issues with cached versions of files being used when dev-debug is enabled, ensuring that the latest versions are always fetched.

Fixes #4696

* Allows spaces in steamcmdcommand variable

Parses steamcmdcommand as an array to allow spaces in the
variable.

This prevents issues when the user wants to pass arguments
with spaces to the steamcmd executable.

* Addresses various script improvements

Addresses multiple improvements across various scripts:

- Fixes Valheim unstripped_corlib override by commenting out the lines in the config files.
- Improves process identification for source and goldsrc engines using `pgrep`.
- Enhances backup file identification using `find` with `-maxdepth 1` and `-type f`.
- Fixes glibc version comparison logic in multiple files.
- Improves UT2K4 key installation script by using printf for writing the key to the file.
- Corrects the mod info extraction logic to correctly identify mod entries.
- Improves amxmodx file installation/removal logic to prevent duplicate entries.
- Fixes server info retrieval to handle spaces in the server list.

Relates to #4696

* Fixes mono repo install exit code check

Corrects the mono repo install exit code check to use the dedicated monorepoexitcode variable, ensuring accurate error detection.

Updates the exit trap to preserve the original exit status, preventing potential loss of information when handling script termination.

* Refactors and reorders core modules

Improves module loading by reordering and refactoring the core modules.

This change addresses inconsistencies and improves the overall structure
of how core modules are handled within the system.
Some fix scripts were renamed to match the module name.

* Makes scripts executable

Changes file permissions to make shell scripts executable.
This ensures that the scripts can be run directly.

Addresses a pre-existing issue.
Related to #4696

* Adds explicit permissions to workflows

Specifies explicit permissions for GitHub Actions workflows to enhance security and control access to resources.

This ensures that each workflow only has the necessary permissions, following the principle of least privilege.

* Fixes output redirection and URL parsing

Corrects output redirection in GitHub Actions workflows by enclosing the $GITHUB_OUTPUT variable in quotes, preventing potential issues with variable expansion.

Ensures proper URL parsing in workflows by enclosing the URL within quotes, addressing potential parsing errors.

Fixes #4696

* Applies code formatting for consistency

Applies Prettier formatting to the codebase for improved
readability and consistency.

Addresses minor code style inconsistencies across several files.

* Fixes minor formatting and logic issues

Addresses various minor issues including:

- Standardizes indentation in `.editorconfig` for different file types.
- Simplifies Prettier configuration.
- Updates image links in `README.md`.
- Ensures newline character at end of `.csv` files.
- Corrects a conditional statement in `command_fastdl.sh`.
- Corrects a conditional statement in `info_messages.sh`.
- Updates server query protocols in `query_gsquery.py`.

* Configures and disables linters

Adds YAML linting configuration and disables unnecessary
linters to streamline the CI/CD process and reduce
noise from irrelevant checks.

* Improves documentation and linting

Updates documentation links to be enclosed in angle brackets, preventing markdown rendering issues.

Configures markdownlint to align with repository standards and avoid common false positives.

The updated links in the documentation ensure they are correctly interpreted by markdown parsers, improving user experience.

The markdownlint configuration fine-tunes linting rules to better match the project's existing style and conventions, reducing noise from irrelevant warnings.

* Fixes typos and improves code consistency

Addresses various typos and inconsistencies across multiple files,
enhancing code readability and maintainability.

Adds codespell and flake8 configurations for linting.

Relates to #4696

* Excludes workflow files from Prettier formatting

Prevents Prettier from formatting workflow files due to GitHub token restrictions, as the token used by the Prettier auto-commit action lacks permissions to update files within the `.github/workflows/` directory.

* chore(prettier): format code

* Updates Super-Linter configuration

Improves Super-Linter's reliability by switching to linting the entire codebase instead of relying on git history. This change also addresses potential transient fetch failures from GitHub.

Additionally, this commit expands the ignored paths in codespell and disables some linters to improve performance and reduce false positives.

---------

Co-authored-by: Copilot <[email protected]>
Co-authored-by: dgibbs64 <[email protected]>

3 months ago

Daniel Gibbs

ee20e18be3

feat: User interface refactor (#4716 )

* refactor: improve log directory creation

- Changed the variable `checklogs` from being set to `1` to being set to `true`.
- Improved the logic for creating log directories and files.
- Added more informative console output for each step of the process.
- Refactored code to use conditional statements instead of nested if statements.
- Removed unnecessary print statements.

This commit improves the way log directories are created and handles cases where logs already exist. It also provides clearer console output during the process.

* refactor: improve console output formatting

- Added color support for console output using tput commands
- Updated print functions to display formatted messages with colors and bold text

* refactor: improve console log creation

The code in `install_logs.sh` has been refactored to improve the creation of the console log. The commit removes unnecessary whitespace and updates the echo statement to provide a more concise output.

* a

* refactor: improve log directory creation messages

- Changed the format of log directory creation messages to include parentheses around the directory path.
- Updated the messages in `install_logs.sh` file to reflect this change.

* refactor: improve log directory symlink creation

The code has been refactored to improve the creation of symlinks for game log directories. The commit removes unnecessary echo statements and updates the output format to provide clearer information about the created symlinks.

* feat: create server directory

- Updated the script to create a server directory
- Removed unnecessary check for existing server directory

* refactor: improve console output for fetching files

The commit refactors the code in `install_server_dir.sh` and `linuxgsm.sh` to improve the console output when fetching files. The message now includes more descriptive information about the file being fetched, such as the source URL and local filename. Additionally, the success message has been updated to include brackets around "OK" for better readability.

* refactor: improve formatting of success message

The success message in the core_messages.sh file has been updated to include square brackets around "OK" for better visibility.

* ui

* refactor: improve console output for checking and fetching files

- Updated the console output in `command_update_linuxgsm.sh` to include formatting and improved readability.
- Improved the console output in `core_dl.sh` to include formatting and better indicate the progress of file fetching.

* refactor: improve logging message in fn_fetch_file

The logging message in the fn_fetch_file function has been improved to provide a more concise and informative output. Instead of mentioning the local filename separately, it is now included within the same line as the file URL name. This change enhances readability and clarity when fetching files.

* refactor: improve console output in core_dl.sh and linuxgsm.sh

- Refactored code to improve the console output in core_dl.sh and linuxgsm.sh.
- Updated echo statements to provide more informative messages.
- Removed unnecessary characters from the console output.

* refactor: improve code readability and remove unnecessary comments

The commit message summarizes the changes made to the code. In this case, the code has been refactored to improve its readability and remove unnecessary comments.

* refactor: improve readability and consistency in code

- Refactored echo statements to provide more informative messages.
- Renamed variables for better clarity.
- Removed unnecessary comments and unused code.

* refactor: improve logging message in core_dl.sh

The logging message in the `fn_fetch_file` function has been updated to provide a more concise and informative description of the file being fetched.

* refactor(core_messages): update print functions

- Updated the print functions in the core_messages.sh file to improve readability and consistency.
- Replaced the use of "tputreset" with "${default}" for better code clarity.
- Modified the formatting of the output messages to follow a consistent pattern.
- Removed unnecessary escape sequences from the echo statements.

* refactor: improve header and server directory installation messages

- Updated ASCII logo formatting for better visibility.
- Added emphasis to the LinuxGSM name in the header message.
- Changed the contributor and sponsor links to be more descriptive.
- Modified the server directory installation message to indicate if a game server already exists at the specified location.

* refactor: improve log directory creation messages

- Changed the log directory creation messages to include square brackets around the directory paths.
- Updated the console log and game log directory creation messages to use square brackets as well.
- Modified the symlink creation messages for game logs and Steam logs to also include square brackets.

This commit improves the readability of the log directory creation process by adding square brackets around the relevant paths.

* refactor: improve log directory creation and server directory installation

- Change log directory creation message to use bold font for emphasis.
- Update symlink creation message to clarify that it is creating a symlink to the game log directory.
- Add a check to skip creating a symlink if it already exists for the Steam log directory.
- Change server directory installation message to use bold font for emphasis.

* refactor: improve log directory symlink creation

This commit refactors the code in `install_logs.sh` to improve the creation of symlinks for game log directories. The commit fixes a typo in the echo statement and updates the symlink paths for both game logs and Steam logs.

* feat: create serverfiles directory

- Updated the message to indicate that a serverfiles directory is being created
- Improved clarity and readability of the code

* refactor: improve consistency and readability of print functions

- Refactored the print functions in the core_messages.sh file to improve consistency and readability.
- Updated the output format by adding ellipsis (...) before each status message for better visual separation.
- Replaced hard-coded color codes with variables for easier maintenance.

Co-authored-by: AI Assistant <[email protected]>

* refactor: improve readability of code in command_update_linuxgsm.sh

- Replaced "checking" with "checking [filename]" for better clarity
- Changed echo statements to use fn_print_update_eol_nl instead of fn_print_ok_eol_nl
- Updated comments for better understanding of the code flow

* refactor: improve logging and error handling in command_update_linuxgsm.sh

- Refactored log messages for better clarity and readability.
- Improved error handling by checking the return value of curl command.
- Updated backup location log message to include brackets.

* refactor: simplify code for checking file differences

The commit simplifies the code for checking file differences in the `command_update_linuxgsm.sh` script. It replaces the function `fn_print_ok_eol_nl` with `fn_print_skip_eol_nl` to improve readability and maintainability.

* refactor: improve print message in command_update_linuxgsm.sh

The code change refactors the print message in the command_update_linuxgsm.sh file. Instead of printing "OK", it now prints "SKIP" to indicate that a module is being removed. This improves clarity and consistency in the script's output.

* skip

* refactor: improve readability and add emphasis to file names in code

- Refactored code to improve readability and maintainability.
- Added emphasis to file names by using italics.
- Updated echo statements to reflect the changes.

* feat: improve fetch file output

- Updated the fetch file function in core_dl.sh and linuxgsm.sh to provide more informative output.
- Replaced the parentheses with square brackets to enclose the local filename.
- Added italics formatting to highlight the local filename.

* feat: improve log directory creation

- Updated log directory creation to include italic formatting for directory names.
- Added italic formatting for script log, console log, game log, and steam log directories.
- Improved serverfiles directory creation by including italic formatting for the directory name.

* refactor: improve readability and consistency in code

- Updated the echo statement to include formatting for script name
- Added bold formatting to EULA acceptance message
- Removed unnecessary line breaks and added italic formatting to EULA URL
- Refactored code to remove duplicate calls to install_eula.sh

* feat: add new line before Y/N prompt

The commit adds a new line before the Y/N prompt in the `fn_prompt_yn` function. This improves readability and user experience.

refactor: improve formatting in install_server_files.sh

The commit improves the formatting in the `install_server_files.sh` file by adding bold styling to the installation header. It also adds bold styling to the separator line for better visual separation. These changes enhance the overall appearance of the installation process.

fix: correct formatting issue in install_server_files.sh

The commit fixes a formatting issue in the `install_server_files.sh` file where an extra separator line was not properly formatted with bold styling. The fix ensures consistent and correct formatting throughout the script.

chore: update prompt message in install_server_files.sh

The commit updates a prompt message in the `install_server_files.sh` file to make it more informative and user-friendly. The updated message asks if the installation was successful, providing clearer instructions for users.

refactor: remove redundant separator line in install_server_files.sh

The commit removes a redundant separator line from the `install_server_files.sh` file that was causing unnecessary visual clutter. This improves code readability and simplifies the installation process.

* changes

* refactor: improve logging and error handling in install_config.sh

- Refactored the code to use more descriptive function names.
- Improved logging by using fn_print_ok_eol and fn_print_failure_eol functions.
- Added error handling for copying config files, displaying failure messages if necessary.
- Updated comments for better clarity.

* refactor: improve logging and remove unnecessary code

- Changed `fn_print_failure_eol` to `fn_print_fail_eol` for consistency.
- Removed redundant log messages and sleep time.
- Simplified the logic for changing hostname and rcon/admin password.
- Removed warning message when config file is not found.

Co-authored-by: AI Assistant <[email protected]>

* refactor: update server names in default configuration files

- Updated the servername value in multiple default configuration files to "LinuxGSM" for consistency.
- Refactored the code to reflect the changes made.

This commit refactors the default configuration files for various game servers by updating the servername value to "LinuxGSM". This change ensures consistency across different game servers.

* refactor: remove unused code and files

This commit removes unused code and files from the project. The deleted files include default configuration files and test scripts that are no longer needed.

* refactor: improve readability and error handling in install_config.sh

- Refactored the code to improve readability by adding bold formatting to console output.
- Improved error handling by using the exit status of commands instead of a separate variable.
- Replaced repetitive sleep calls with fn_sleep_time function.
- Updated log messages for clarity and consistency.
- Added conditional checks for successful file copying and printing appropriate status messages.

Co-authored-by: AI Assistant <[email protected]>

* refactor: simplify config file copying and error handling

This commit simplifies the code for copying default config files from the Game-Server-Configs repository to the server's config location. It also improves error handling by printing appropriate messages and logging them.

* misc changes

* reword of dst config install

Removed install settings as it complicates setup. The admin  how has to manually setup a slave shard using configs. By default LinuxGSM will setup a Master shard. Docs will need to be updated.

* refactor: improve config location listing

- Renamed the function `fn_list_config_locations` to better reflect its purpose.
- Updated the output messages to provide clearer information about the config locations.
- Added formatting enhancements for better readability.

This commit refactors the code related to listing config locations, making it more user-friendly and informative.

* ui changes

* refactor: improve code readability and fix typos

- Refactored the code to improve readability and organization.
- Fixed typos in the comments and echo statements.
- Changed some echo statements to use variables for better consistency.
- Updated URLs in the echo statements to be clickable links.

Co-authored-by: [co-author name]

* ui changes

* ui changes

* fix: update warning message for missing SteamCMD

The commit updates the warning message in the code to indicate that SteamCMD is not installed instead of being missing. Additionally, it modifies the log message accordingly.

* refactor: simplify directory creation in install_config.sh

This commit simplifies the code for creating config directories in the install_config.sh file. Instead of using separate variables for each directory path, it now uses a single variable to create the necessary directories. This improves readability and reduces redundancy in the code.

* feat: add installation and information for SteamCMD

- Added code to install SteamCMD if it is missing or the steamcmd directory is missing.
- Modified the check_steamcmd function to print a warning message if SteamCMD is not installed.
- Modified the info_game_dst function to retrieve additional information from server and cluster configuration files.
- Updated the installation script to display a bold header before installing SteamCMD.

* refactor: improve error message in install_config.sh

The commit refactors the code in `install_config.sh` to improve the error message when copying a config file. The function `fn_print_failure_eol_nl` is renamed to `fn_print_fail_eol_nl` for clarity and consistency. This change enhances the readability and maintainability of the code.

* refactor: improve conditional statements in install_config.sh

The code changes refactor the conditional statements in the `install_config.sh` file. Instead of checking if `${shortname}` is equal to "dst" or "arma3", it now checks if `${clustercfgdir}` or `${networkcfgdir}` are not empty, respectively. This improves readability and maintainability of the code.

a

* refactor: simplify config directory creation and copying

The code changes simplify the logic for creating config directories and copying config files. The function `fn_check_cfgdir` now only creates the server config directory if it exists, removing unnecessary checks for other directories. Additionally, the function `fn_default_config_remote` no longer duplicates the call to `fn_check_cfgdir`.

* refactor: improve variable naming and remove unnecessary code duplication

The commit refactors the code in `install_config.sh` to improve variable naming and remove unnecessary code duplication. Specifically, it renames the variables for better clarity and removes redundant lines of code.

refactor: improve installation and configuration process

- Refactored the fix_dst.sh script to keep the shard name in server.ini consistent with the LinuxGSM config.
- Updated install_config.sh to provide clearer messages during the default config download and copy processes.

refactor: update shard name in server.ini

The code has been refactored to update the shard name in the server.ini file. This change ensures that the shard name in the LinuxGSM config matches the one in server.ini.

* feat: improve console output formatting

- Added separator function to improve readability of console output.
- Replaced multiple instances of manual separators with the new function.
- Updated commit message to follow conventional commit standard.

* refactor: remove unnecessary fn_sleep_time calls

This commit removes the fn_sleep_time function calls that are no longer needed in multiple modules. The fn_sleep_time function was used to introduce a delay, but it is no longer necessary for the current implementation.

* refactor: remove unused functions

This commit removes a large number of unused functions from the core_functions.sh module. These functions were not being called or used anywhere in the codebase and were therefore unnecessary. Removing them helps to clean up the code and improve maintainability.

* refactor: improve consistency and readability of code

- Changed the color of "Missing Server Details" to bold yellow
- Changed the color of "Query IP Addresses" to bold yellow
- Changed the color of "Game Server Ports" to bold yellow
- Changed the color of "SS Output" to bold yellow
- Changed the color of "Query Port - Raw Output" to bold yellow
- Changed the color of "Gamedig Raw Output" to bold yellow
- Changed the color of "gsquery Raw Output" to bold yellow
- Changed the color of "TCP Raw Output" to bold yellow
- Changed the color of "Game Port - Raw Output" to bold yellow
- Changed the color of "Steam Master Server Response" to bold yellow
- Updated commit message formatting for better readability

* refactor: improve code readability and efficiency in command_dev_query_raw.sh

- Simplify conditionals by replacing [ -v var ] with [ -n "${var}" ]
- Remove unnecessary checks for the presence of jq and gamedig
- Update output headers to be more descriptive and consistent
- Use italic formatting for curl command in Steam Master Server Response section

* refactor: improve query output formatting

The code changes refactor the query output formatting in the command_dev_query_raw.sh file. The changes include:
- Adding italics to certain command outputs for better readability
- Removing unnecessary echo statements
- Updating comments and indentation for clarity

* refactor: simplify storage information display

The code in `info_messages.sh` has been refactored to improve the readability and conciseness of the storage information display. The labels for total and used space have been shortened to "Total" and "Used" respectively.

* refactor: renamed fatal to fail to improve consistency

- Updated the log level from "fatal" to "fail" in the alert scripts.

* feat: add conditional printing of alert messages

This commit adds conditional statements to only print alert messages if the corresponding alerts are turned on. This improves the readability of the output by only displaying relevant information.

- Added conditionals for Discord, Email, Gotify, IFTTT, Pushbullet, Pushover, Rocketchat, Slack, and Telegram alerts
- Only prints alert messages if the corresponding alerts are turned on

* feat: improve console and post details commands

- Updated the console command to display a link in italics to the documentation.
- Updated the post details command to display the URL in italics for support.
- Renamed "Donation options" to "Sponsorship options" in the sponsor command.
- Added Minecraft as an example of a game with query enabled in info messages.

Closes #123

* quit

* update fn_bootstrap_fetch_file

* ui changes

* bootstrap trap

* ui updates

* att bootstrap fetch module

* ui updates

* bug

* merge 2 functions

* ui changes

* config ui changes

* installer ui changes

* installer ui changes

* add fn_print and fn_print_nl

* remove space

* add new dev command ui

* bug

* skip to light blue

* update to light blue

* reset to default

* update ui changes

* steamui changes

* print

* fix

* sleep time

* validate

* remote location

* italic url

* fastdl

* fn_print

* fix

* ui

* speed up

* fastdl ui

* ui fix

* ui fix

* update some headers

* header updates

* minor changes

* install changes

* messages refactor

* ui changes

* bug

* standardise exitcode

* tidy

* bug

* bug

* revert

* updating dev ui

* ui changes

* bug

* skip

* bug

* change minimum required message

* fix incorrect var name

* ui updates

* remove ) from results

* revert

* ensure command action capitals are consistant

* revert

* revert

* revert

* codacy

* revert

* revert

---------

Co-authored-by: AI Assistant <[email protected]>
Co-authored-by: AI Assistant <[email protected]>

2 years ago

2 Commits (b346e68fd596661576cbf1c05eb9ca96072f2a93)