Skip to content

Latest commit

 

History

History
76 lines (61 loc) · 2.83 KB

README.md

File metadata and controls

76 lines (61 loc) · 2.83 KB

Hoax

Hoax is an alternative to CheatEngine for Linux users. It aims to provide a more complete feature set than other alternatives such as PINCE and GameConqueror

hoax.png

Requirements

libscanmem        scanner for Linux
gdb               allows for process debugging
fltk              C++ UI library
python3           for scripts
python3-pygments  assembly syntax highlighting

Issues

  • TODO process list does not update good first commit!
  • TODO documentation or guide good first commit!
  • TODO address value updater (background thread)

Roadmap

  • documentation good first commit!
  • theming good first commit!
  • standardized configuration good first commit!
  • plugin protocol
  • signature generator
  • assembler (replace existing assembly with your own) [CE feature]
  • find out what accesses / writes to this address [CE feature]
  • memory view
  • scanning
    • strings
    • byte arrays
    • ints/floats
    • comprehensive expressions
  • pointer scan [CE feature]
  • save feature [CE feature]

Contribute

Contributions are highly welcomed, as Hoax strives to become a feature complete CheatEngine alternative in the future.

Make sure that changes are in line with the project direction, utilize the roadmap found in README.md or open an issue if unsure.

Recommendation: For your first couple of PRs, start with something small to get familiar with the project and its development processes.

Guidelines

  • Match casing with existing code
  • Both C and C++ code is welcomed
  • Python is the primary scripting language for interfacing with GDB and scanmem

Example Git workflow

The recommended way to work on Torr is by cloning the main repository locally, then forking it on GitHub and adding your repository as a Git remote:

git remote add myfork git@github.com:MyUsername/Hoax.git

You can then create a new branch and start making changes to the code:

git checkout -b mybranch

And finally push the commits to your fork:

# ONLY run this the first time you push
git push --set-upstream myfork mybranch
# This will work for further pushes
git push

If you wish to sync your branch with master, or locally resolve merge conflicts, use:

# On mybranch
git fetch origin
git rebase master

Communication

GitHub is the main platform for communication @ DevGev/Hoax.