# GTFOExplorer

**Repository Path**: yhyu13/gtfoexplorer

## Basic Information

- **Project Name**: GTFOExplorer
- **Description**: Graph The File Explorer (G.T.F.O), a corss-platform file explorer made in python
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: milestone2
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-06-11
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Feature

## Source Inspection Mode
```Crtl + Alt + I``` to toggle back and forth 'source inpsection mode' where you can inspect where GUI elements are defined (via VSCode)  with ```RMB```

# Document

## Read The Doc

TODO

# Development Guide

## Conda Environment

1, Install Anaconda3

2, ```conda env create --file gtfo39.yml```

3, ```conda activate gtfo39 && pip install -r requirements.txt```

## Pyinstaller native executable

1, ```conda activate gtfo39```

2, ```pyinstaller main_win.spec```

3, If compiled successfully, the native build is available under ```./dist``` folder

## Doxygen

1, Install doxygen>=1.9.4, and make sure its executables are added to PATH

2, ```cd Document && doxygen .```

## Dearpygui Source Build

1, Pull the custom branch of dpg by ```git submodule update --init --recursive```

2, It reuiqres cmake>=3.24.0 and Visual Studio 2022 MSVC tool chain to build the dpg
wheel: ```cd ./3rdParty/Dearpygui/ && conda activate gtfo39 && python setup.py bdist_wheel```

3, If compiled successfully, you can then uninstall dpg and install the newly build wheel generated
under ```./3rdParty/Dearpygui/dist``` folder

## Code of Conduct

1, Use ```from Source.Utility.debug import debug \ debug.pprint(...)``` for debug printing (which is not logged).
By default, ```debug.pprint``` would be enabled by ```--pprint=True``` flag in ```main.py```.