Skip to content

Commit

Permalink
add progress documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rr- committed Feb 10, 2021
1 parent 7f78ab6 commit bcadfd2
Show file tree
Hide file tree
Showing 6 changed files with 1,497 additions and 4 deletions.
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,7 @@ docker_build:
lint:
clang-format-10 -i $(wildcard **/*.h **/*.c)

.PHONY: build docker_build lint
docs:
python3 docs/render_progress.py

.PHONY: build docker_build lint docs
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Currently the following configuration options are supported:
- `disable_healing_between_levels`: disables healing Lara between level reloads
(for No Heal challenge runs).
- `enable_red_healthbar`: replaces the default golden healthbar with a red one.
- `enable_enemy_healthbar`: enables showing healthbar for the active enemy
- `enable_enemy_healthbar`: enables showing healthbar for the active enemy.
- `fix_end_of_level_freeze`: fix game freeze when ending the level with the
Action key held
Action key held.

## Building

Expand All @@ -39,6 +39,14 @@ Currently the following configuration options are supported:
To compile the project, run `make build`.
To compile the project with Docker, run `make docker_build`.

## Decompilation progress

![](docs/progress.svg)

Green squares represent TombATI functions that are fully decompiled and
reimplemented by TR1Main. Light red squares represent functions that still need
to be ported.

## License

This project is licensed under the GNU General Public License - see the
Expand Down
Loading

0 comments on commit bcadfd2

Please sign in to comment.