https://github.com/slice/havoc
discord client instrumentation toolkit
https://github.com/slice/havoc
Last synced: 5 months ago
JSON representation
discord client instrumentation toolkit
- Host: GitHub
- URL: https://github.com/slice/havoc
- Owner: slice
- License: mit
- Created: 2021-04-26T02:44:10.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-04T07:06:28.000Z (over 2 years ago)
- Last Synced: 2025-09-10T08:39:08.250Z (7 months ago)
- Language: Rust
- Homepage:
- Size: 855 KB
- Stars: 32
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# havoc
havoc is a [Discord] client instrumentation toolkit written in [Rust] that aims
to be robust, correct, and efficient. [watchdog] is a persistent daemon-like
program that leverages havoc to monitor for new builds, exposes a fluent HTTP
API, and performs code and asset diffing between builds. [spectacles] is a
frontend that consumes this information, collating and presenting it in a
beautiful and easy-to-understand way.
havoc and friends are intended to be useful tools to client modders and curious
onlookers alike, and is especially designed to cater to people who would benefit
from an easier time inspecting the client's code. User friendliness and
experience is an overall priority.
**These projects are currently a heavy work-in-progress** and aren't ready for
general consumption just yet. They'll become minimum viable products eventually,
but will likely require maintenence indefinitely due to the nature of the
project.
[rust]: https://www.rust-lang.org
[watchdog]: /crates/watchdog
[spectacles]: /spectacles
[discord]: https://discord.com
## Usage
We currently don't provide pre-built binaries. To get started, make sure you
have a functional [Rust] toolchain on your machine (try [rustup]). Clone the
repository and try out these commands in a shell:
[rustup]: https://rustup.rs
```sh
# Scrape the latest Canary build and output basic information (such as the
# build number, ID, and assets) to stdout.
$ cargo run --bin havoc -- scrape fe:canary
# Scrape the latest Canary build, parsing and dumping all Webpack modules'
# source code into a JSON file in the current directory, keyed by module ID.
$ cargo run --bin havoc -- scrape fe:canary --dump modules
```
## License
havoc and related projects are distributed under the MIT License. See the
[LICENSE](LICENSE) file for more details.