Introduction

Flags

General Usage

Flags are command-line arguments that modify the behaviour of the Logicytics.py script. They provide a flexible way to execute specific parts of the program or alter its default behaviour. To use a flag, include it after the script name when running it from the command line, preceded by two hyphens (--). For example:

.\Logicytics.py -h

This command would run the help menu of Logicytics.

Specific Flags

Below is a list of specific flags you can use with Logicytics.py:

Logicytics.py [-h] [--default] [--minimal] [--unzip-extra] [--backup]
                     [--restore] [--update] [--extra] [--dev] [--exe]
                     [--debug] [--modded] [--threaded] [--webhook] [--reboot]
                     [--shutdown]

-h: Show this help message and exit
--default: Runs Logicytics default
--minimal: Run Logicytics in minimal mode. Just bare essential scraping

--unzip-extra: Unzip the extra directory zip File - Use on your own device only
--backup: Backup Logicytics files to the ACCESS/BACKUPS directory - Use on your own device only
--restore: Restore Logicytics files from the ACCESS/BACKUPS directory - Use on your own device only
--update: Update Logicytics from GitHub - Use on your own device only
--extra: Open the extra directory for more tools
--dev: Run Logicytics developer mode, only for registering contributions properly - Use on your own device only
--exe: Run Logicytics using its precompiled EXE files. These may be outdated and not optimal, use only if the device doesn't have Python installed
--debug: Runs the Debugger, checks for any issues, warnings, etc. Useful for debugging and issue reporting
--modded: Runs the normal Logicytics, as well as any file in the MODS directory. Useful for custom scripts
--threaded: Runs Logicytics using threads, allowing it to run in parallel
--webhook: Sends the output ZIP file via webhook
--reboot: Reboots the device after execution
--shutdown: Shuts down the device after execution
                

Flags Compatibility and Restrictions

Certain flags can only be used by themselves, while others can be combined. It's important to understand the compatibility and restrictions of these flags:

• Flags that must be used alone:
• --unzip-extra
• --backup
• --restore
• --update
• --extra
• --dev
• --debug
• Unique flags that can't be used with each other but can be used with sub-action flags:
• --default
• --minimal
• --extra
• --exe
• --modded
• --threaded
• Sub-action flags that can't be used with each other and must be paired with a primary action flag:
• --webhook
• --reboot
• --shutdown

Choosing multiple incompatible flags will result in an error, emphasizing the need for specificity in how you wish to execute the script. Understanding the nuances of flag compatibility and the strict requirement for a single run flag is crucial for effectively leveraging the full potential of Logicytics.py.

File Structure

The Logicytics project is organized into several directories, each serving a distinct purpose:

/Logicytics
├─── /.github [You may ignore this]
│    ├─── /ISSUE_TEMPLATE
│    └─── /workflows
├─── /.idea [You may ignore this]
│    └─── inspectionProfiles
├─── /ACCESS [Generated files output]
│    ├─── /BACKUP
│    ├─── /DATA
│    │    ├─── /Hashes
│    │    └─── /Zip
│    └─── /LOGS
│         └─── /DEBUG
├─── /CODE
│    ├─── /SysInternal_Suite
│    │    └─── # SYS INTERNAL EXE #
│    ├─── # THE CODE #
│    └─── /__pycache__ [You may ignore this]
├─── /EXTRA
│    └─── # ZIPPED EXTRA FEATURES #
├─── /WEB
│    └─── # Website Files #
├─── /IMG [You may ignore this]
└─── /MODS [You add your own mods]
                

Access Directory

The ACCESS directory is crucial for monitoring the progress and results of Logicytics operations. The LOGS subdirectory contains the most recent debugger logs, which can be invaluable for diagnosing issues or understanding the behaviour of the script. The DATA subdirectory holds all compressed files produced by Logicytics as well as hashes. Finally, the BACKUP subdirectory contains the necessary backups, providing a centralized location for managing these resources.

By thoroughly understanding and utilizing these sections and flags, users can maximize the efficiency and effectiveness of Logicytics.py, tailoring its capabilities to meet their specific needs and workflows.