mirror of
https://github.com/isledecomp/isle.git
synced 2025-02-16 19:50:15 -05:00
b14116cc93
* Create common print_diff function * Add pylint and black * Fix linting, move classes to utils * Add black/pylint to github actions * Fix linting * Move Bin and SymInfo into their own files * Split out format * Tidy up workdlows and pip, add readme * Lint tests, add tests to readme
50 lines
1.1 KiB
Markdown
50 lines
1.1 KiB
Markdown
# LEGO Island Decompilation Tools
|
|
|
|
These are a set of Python tools for helping with the decomp project
|
|
|
|
## Installing
|
|
Use pip to install the required packages:
|
|
|
|
```
|
|
pip install -r tools/requirements.txt
|
|
```
|
|
|
|
## reccmp
|
|
This is a script to compare the original EXE or DLL with a recpmpiled EXE or DLL, provided a .PDB file
|
|
|
|
## verexp
|
|
This verifies exports by comparing the exports of an original DLL and the recompiled DLL
|
|
|
|
## checkorder
|
|
This checks the order of C++ source and header files to make sure the functions are in order
|
|
|
|
## isledecomp
|
|
This is a library that is used by rhe above scripts. it has a collection of useful classes and functions
|
|
|
|
### Testing
|
|
`isledecomp` has a small suite of tests. Install pylint and run it, passing in the directory:
|
|
|
|
```
|
|
pip install pytest
|
|
pytest tools/isledecomp/tests/
|
|
```
|
|
|
|
## Development
|
|
In order to keep the code clean and consistent, we use `pylint` and `black`:
|
|
|
|
```
|
|
pip install black pylint
|
|
```
|
|
### To run pylint (ignores build and virtualenv):
|
|
```
|
|
pylint tools/ --ignore=build,bin,lib
|
|
```
|
|
|
|
### To check code formatting without rewriting files:
|
|
```
|
|
black --check tools/
|
|
```
|
|
### To apply code formatting:
|
|
```
|
|
black tools/
|
|
```
|