Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@

<p align="center">
<a href="https://github.com/JeanExtreme002/Picklock/actions/workflows/python-package.yml"><img src="https://github.com/JeanExtreme002/Picklock/actions/workflows/python-package.yml/badge.svg" alt="Python Package" /></a>
<a href="https://pypi.org/project/Picklock/"><img src="https://img.shields.io/pypi/v/Picklock" alt="Pypi" /></a>
<a href="https://pypi.org/project/picklock/"><img src="https://img.shields.io/pypi/v/Picklock" alt="Pypi" /></a>
<a href="https://github.com/JeanExtreme002/Picklock"><img src="https://img.shields.io/pypi/l/Picklock" alt="License" /></a>
<a href="https://github.com/JeanExtreme002/Picklock"><img src="https://img.shields.io/badge/python-3.10+-8A2BE2" alt="Python Version" /></a>
<a href="https://pypi.org/project/picklock/"><img src="https://static.pepy.tech/personalized-badge/picklock?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads" alt="Downloads" /></a>
</p>

---
Expand All @@ -36,27 +37,15 @@ Full documentation lives at **[picklock.readthedocs.io](https://picklock.readthe
the scan cycle, address expressions, pointer chains, scripting, platform
permissions, and every command's arguments.

<table>
<tr><td><a href="https://picklock.readthedocs.io/en/latest/quickstart.html"><b>Quick start</b></a></td><td>Attach to a process, find a value, change it.</td></tr>
<tr><td><a href="https://picklock.readthedocs.io/en/latest/guide/scanning.html"><b>Scanning</b></a></td><td>The first-scan/refine cycle, AOB and regex scans.</td></tr>
<tr><td><a href="https://picklock.readthedocs.io/en/latest/guide/addresses.html"><b>Addresses</b></a></td><td><code>module+offset</code>, dereferences, and <code>#N</code> scan rows.</td></tr>
<tr><td><a href="https://picklock.readthedocs.io/en/latest/guide/reading-writing.html"><b>Reading and writing</b></a></td><td>Value types, typed reads and writes, hex views and watches.</td></tr>
<tr><td><a href="https://picklock.readthedocs.io/en/latest/guide/pointers.html"><b>Pointers</b></a></td><td>Pointer scans, and the workflow that makes a path survive a restart.</td></tr>
<tr><td><a href="https://picklock.readthedocs.io/en/latest/guide/scripting.html"><b>Scripting</b></a></td><td>Non-interactive use, exit codes, JSON export.</td></tr>
<tr><td><a href="https://picklock.readthedocs.io/en/latest/reference/commands.html"><b>Command reference</b></a></td><td>Every command and flag, generated from the code.</td></tr>
<tr><td><a href="https://picklock.readthedocs.io/en/latest/permissions.html"><b>Permissions</b></a></td><td>What each OS wants before it lets you attach.</td></tr>
<tr><td><a href="https://picklock.readthedocs.io/en/latest/troubleshooting.html"><b>Troubleshooting</b></a></td><td>Scans that find nothing, chains that stop working.</td></tr>
</table>

Use `help` to list Picklock's commands, and `help <command>` to get more details about one command.

## 🤝 Contributing
## Contributing

Pull requests, bug reports and feature ideas are very welcome. Read
[CONTRIBUTING.md](https://github.com/JeanExtreme002/Picklock/blob/main/CONTRIBUTING.md) for the development setup, test layout and
the small set of platform-specific quirks to be aware of.

## Related
## Related

Every read, write, scan and pointer walk is performed by
[PyMemoryEditor](https://github.com/JeanExtreme002/PyMemoryEditor), the
Expand Down
Binary file modified assets/screenshots/terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
try:
from picklock import __version__ as release
except Exception: # pragma: no cover - docs can build without the package installed
release = "0.2.1"
release = "0.2.2"

version = ".".join(release.split(".")[:2])

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ picklock
```

```
Welcome to Picklock 0.2.1, a terminal client for PyMemoryEditor.
Welcome to Picklock 0.2.2, a terminal client for PyMemoryEditor.
Type 'help' for the command list, or 'help scanning' for a walkthrough.

picklock>
Expand Down
2 changes: 1 addition & 1 deletion picklock/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"""

__author__ = "Jean Loui Bernard Silva de Jesus"
__version__ = "0.2.1"
__version__ = "0.2.2"

from .errors import CommandError, NoProcessError, PicklockError
from .session import Session
Expand Down
Loading