Skip to content

lucko/spark-viewer

Repository files navigation

spark-viewer

spark is a performance profiling plugin/mod for Minecraft clients, servers, and proxies.

This repository contains the website & viewer for spark, written using Next.js/React/Typescript.

The website contains:

  • a brief homepage
  • downloads page which serves direct links to the latest release
  • documentation, although this is managed in a separate repository
  • a viewer web-app for spark data, which has modes for:
    • viewing the output from the spark profiler
    • viewing the output from spark heap dump summaries

Viewer

The viewer component of the website reads data from bytebin (content storage service) and bytesocks (WebSocket server). It then renders this data as an interactive viewer in which the user can interpret and analyse their results.

The profile viewer renders the data as an expandable call stack tree, with support for applying deobfuscation mappings, searching, bookmarks and viewing as a flame graph.

The heap dump summary viewer renders a histogram of the classes occupying the most memory at the time when the data was collected.

Contributions

Yes please! - but please open an issue or ping me on Discord (so we can discuss your idea) before working on a big change!

License

spark is free & open source. It is released under the terms of the GNU GPLv3 license. Please see LICENSE.txt for more information.

spark is a fork of WarmRoast, which was also licensed using the GPLv3.