diff --git a/Modules/constants/standalone.py b/Modules/constants/standalone.py index 6dcb286..d61dc18 100644 --- a/Modules/constants/standalone.py +++ b/Modules/constants/standalone.py @@ -1,5 +1,5 @@ TITLE = "Session Sniffer" -VERSION = "v1.3.0 - 04/01/2024 (15:04)" +VERSION = "v1.3.0 - 06/01/2024 (23:10)" USER_SHELL_FOLDERS_REG_KEY = R"SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders" USERIP_INI_SETTINGS_LIST = ["ENABLED", "COLOR", "NOTIFICATIONS", "VOICE_NOTIFICATIONS", "LOG", "PROTECTION", "PROTECTION_PROCESS_PATH", "PROTECTION_RESTART_PROCESS_PATH", "PROTECTION_SUSPEND_PROCESS_MODE"] WIRESHARK_RECOMMENDED_FULL_VERSION = "TShark (Wireshark) 4.2.9 (v4.2.9-0-g2acaabc9099c)." diff --git a/docs/CREDITS_and_CONTRIBUTORS.md b/docs/CREDITS_and_CONTRIBUTORS.md index 396e9fe..91012a0 100644 --- a/docs/CREDITS_and_CONTRIBUTORS.md +++ b/docs/CREDITS_and_CONTRIBUTORS.md @@ -7,7 +7,7 @@ @Rosalyn - Giving me the force and motivation. @Butters333 - Gived me new ideas for things to code: - The ability to hide the date or time, allowing users to display only the elapsed time, date, time, or any combination of these fields, depending on their preference. - - Support for displaying any IP lookup fields in the console output and logs. + - Support for displaying any IP lookup fields. # Contributors diff --git a/docs/SCRIPT_CONFIGURATION.md b/docs/SCRIPT_CONFIGURATION.md index 13069a7..efabbcf 100644 --- a/docs/SCRIPT_CONFIGURATION.md +++ b/docs/SCRIPT_CONFIGURATION.md @@ -25,29 +25,18 @@ CAPTURE_VPN_MODE=False CAPTURE_OVERFLOW_TIMER=3.0 CAPTURE_PREPEND_CUSTOM_CAPTURE_FILTER=None CAPTURE_PREPEND_CUSTOM_DISPLAY_FILTER=None -STDOUT_SHOW_ADVERTISING_HEADER=False -STDOUT_SESSIONS_LOGGING=True -STDOUT_RESET_PORTS_ON_REJOINS=True -STDOUT_FIELDS_TO_HIDE=['Intermediate Ports', 'First Port', 'Continent', 'R. Code', 'City', 'District', 'ZIP Code', 'Lat', 'Lon', 'Time Zone', 'Offset', 'Currency', 'Organization', 'AS', 'ASN / ISP'] -STDOUT_DATE_FIELDS_SHOW_DATE=False -STDOUT_DATE_FIELDS_SHOW_TIME=False -STDOUT_DATE_FIELDS_SHOW_ELAPSED=True -STDOUT_FIELD_SHOW_COUNTRY_CODE=True -STDOUT_FIELD_SHOW_CONTINENT_CODE=True -STDOUT_FIELD_CONNECTED_PLAYERS_SORTED_BY=Last Rejoin -STDOUT_FIELD_DISCONNECTED_PLAYERS_SORTED_BY=Last Seen -STDOUT_FIELD_COUNTRY_MAX_LEN=20 -STDOUT_FIELD_CITY_MAX_LEN=20 -STDOUT_FIELD_CONTINENT_MAX_LEN=20 -STDOUT_FIELD_REGION_MAX_LEN=20 -STDOUT_FIELD_ORGANIZATION_MAX_LEN=20 -STDOUT_FIELD_ISP_MAX_LEN=20 -STDOUT_FIELD_ASN_ISP_MAX_LEN=20 -STDOUT_FIELD_AS_MAX_LEN=20 -STDOUT_FIELD_AS_NAME_MAX_LEN=20 -STDOUT_DISCONNECTED_PLAYERS_TIMER=10.0 -STDOUT_DISCONNECTED_PLAYERS_COUNTER=6 -STDOUT_REFRESHING_TIMER=0.1 +GUI_SESSIONS_LOGGING=True +GUI_RESET_PORTS_ON_REJOINS=True +GUI_FIELDS_TO_HIDE=['Intermediate Ports', 'First Port', 'Continent', 'R. Code', 'City', 'District', 'ZIP Code', 'Lat', 'Lon', 'Time Zone', 'Offset', 'Currency', 'Organization', 'AS', 'ASN / ISP'] +GUI_DATE_FIELDS_SHOW_DATE=False +GUI_DATE_FIELDS_SHOW_TIME=False +GUI_DATE_FIELDS_SHOW_ELAPSED=True +GUI_FIELD_SHOW_COUNTRY_CODE=True +GUI_FIELD_SHOW_CONTINENT_CODE=True +GUI_FIELD_CONNECTED_PLAYERS_SORTED_BY=Last Rejoin +GUI_FIELD_DISCONNECTED_PLAYERS_SORTED_BY=Last Seen +GUI_DISCONNECTED_PLAYERS_TIMER=10.0 +GUI_DISCONNECTED_PLAYERS_COUNTER=6 USERIP_ENABLED=True DISCORD_PRESENCE=True ``` @@ -114,84 +103,54 @@ Learn more: [Wireshark Capture Filters](https://wiki.wireshark.org/CaptureFilter **For advanced users**; Allows you to specify a custom Tshark display filter, which will be prepended to the filter used in the script. Learn more: [Wireshark Display Filters](https://wiki.wireshark.org/DisplayFilters) / [Tshark Display Filters](https://tshark.dev/analyze/packet_hunting/packet_hunting/) -* `` -Determine if you want or not to show the developer's advertisements in the script's display. +* `` +Determine if you want to log the gui session's output to the "Sessions Logging" folder. +It is synced with the gui tables output and contains all fields. -* `` -Determine if you want to log console's output to "SessionsLogging" folder. -It is synced with the console output and contains all fields. - -* `` +* `` When a player rejoins, clear their previously detected ports list. -* `` +* `` Specifies a list of fields you wish to hide from the output. It can only hides field names that are not essential to the script's functionality. Valid values include any of the following field names: -{Settings.stdout_hideable_fields} +["Last Port", "Intermediate Ports", "First Port", "Continent", "Country", "Region", "R. Code", "City", "District", "ZIP Code", "Lat", "Lon", "Time Zone", "Offset", "Currency", "Organization", "ISP", "ASN / ISP", "AS", "ASN", "Mobile", "VPN", "Hosting"] -* `` +* `` Shows or not the elapsed time from which a player has been captured in "First Seen", "Last Rejoin" and "Last Seen" fields. -* `` +* `` Shows or not the date from which a player has been captured in "First Seen", "Last Rejoin" and "Last Seen" fields. -* `` +* `` Specify whether to display the continent's ISO 2-letter code in parentheses next to the continent name. -* `` +* `` Specify whether to display the country's ISO 2-letter code in parentheses next to the country name. -* `` +* `` Specifies the fields from the connected players by which you want the output data to be sorted. Valid values include any field names. For example: Last Rejoin -* `` +* `` Specifies the fields from the disconnected players by which you want the output data to be sorted. Valid values include any field names. For example: Last Seen -* `` -Maximum allowed length for the "Country" field. - -* `` -Maximum allowed length for the "City" field. - -* `` -Maximum allowed length for the "Continent" field. - -* `` -Maximum allowed length for the "Region" field. - -* `` -Maximum allowed length for the "Organization" field. - -* `` -Maximum allowed length for the "ISP" field. - -* `` -Maximum allowed length for the "ASN / ISP" field. - -* `` -Maximum allowed length for the "AS" field. - -* `` -Maximum allowed length for the "AS Name" field. - -* `` +* `` The duration after which a player will be moved as disconnected on the console if no packets are received within this time. Valid values include any number greater than or equal to 3. -* `` +* `` The maximum number of players showing up in disconnected players list. Valid values include any number greater than or equal to 0. Setting it to 0 will make it unlimitted. -* `` -Minimum time interval between which this will refresh the console display. - * `` Determine if you want or not to enable detections from the UserIP databases. +* `` +Determine if you want or not to enable Discord presence. + ### Scan trough a VPN diff --git a/docs/TIPS_and_TRICKS.md b/docs/TIPS_and_TRICKS.md index eaeea1f..1cf6587 100644 --- a/docs/TIPS_and_TRICKS.md +++ b/docs/TIPS_and_TRICKS.md @@ -2,6 +2,7 @@ ## General Tips and Tricks +- I recommend using [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/) for an optimal experience. - You can handily zoom in or out on your terminal's output by using the keyboard shortcut `[CTRL] + [Mouse_Scroll]` or `[CTRL] + [+]`, and `[CTRL] + [-]`. - You can pause your terminal's output by using the keyboard shortcut `[CTRL] + [S]` and resume it with `[CTRL] + [Q]`. diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index 0f02e47..9ea2af8 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -2,7 +2,7 @@ ## Scanner is stuck -When the scanner is stuck at `"Scanning IPs, refreshing display in x second ..."`, it typically indicates one of the following situations: +When the scanner is stuck (no IPs detected), it typically indicates one of the following situations: - You are not currently in an online session with at least one other player. - The configuration for the script may not be set up correctly. @@ -39,9 +39,3 @@ For example: ``` This capture and display filter serves as an example and demonstrates various ways to block an IP, multiple IPs, or an IP range/CIDR. - -## About Screen Refreshing - -Refreshing the display of the script positions your terminal's cursor at the very bottom of the script. -However, if you are using Windows Terminal, this issue is somewhat resolved because the view sticks to the top of the page by scrolling there initially. -I recommend using [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/) for an optimal experience.