godotengine/godot-benchmarks
1
0
Fork 0
mirror of https://github.com/godotengine/godot-benchmarks.git synced 2026-01-04 06:10:04 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
caf532112ebaa5412eb1871fb1d6491a0c5d244d
godot-benchmarks/web/README.md
Lukas Tenbrink 5a0c43c8c7 Replace ApexCharts with Plotly.js (#117) 
- Use 1200px as website width, and make it a 3-column layout.
- Switch graphs to log y scale, and show 0.2x to 5x by default.

ApexCharts currently struggles with log y scales, glitches with outliers
(at least in Safari), and does not support extensive graph interaction
(like double clicking traces to isolate, and the toolbar).
2025-08-20 01:32:28 +02:00

2.0 KiB
Raw Blame History

Web interface for benchmark results

This website is built with the Hugo static site generator. It's designed to work exclusively with the run-benchmarks.sh script, which runs benchmarks on a dedicated server with various GPU models.

How it works

  • Using the run-benchmarks.sh script, benchmark data is collected and saved to a single JSON file for each engine commit, with 4 runs:
    • CPU (debug template)
    • CPU (release template)
    • GPU (AMD, release template)
    • GPU (Intel, release template)
    • GPU (NVIDIA, release template)
  • The produced results (as .json or .md) should be copied into the src-data/benchmarks folder.
  • The ./generate-content.py script produces .md files in the content folder, so that web pages can be generated for each graph and each benchmark.
  • Hugo is used to create a homepage listing recent benchmarked commits, plus a single page per engine commit. This allows linking to individual benchmarked commit in a future-proof way.
  • Plotly.js is used to draw graphs on the homepage.
  • Water.css is used to provide styling, including automatic dark theme support.

Building

Development

  • Create JSON data or fetch existing JSON data from the live website, and copy the JSON files into the src-data/benchmarks folder. Files should be named using format YYYY-MM-DD_hash.json where hash is a 9-character Git commit hash of the Godot build used (truncated from a full commit hash). The files can also have the .md extension (for backward compatibility), but they should still be JSON inside.
  • Run ./generate-content.py. This should create .md pages in both the content/benchmark and the content/graph folders.
  • Run hugo server.

Production

  • Follow the same steps as in the Development section above.
  • Run hugo --minify.