🍿 Hearthstone replays in your browser.
Clone or download
Latest commit 6cb3ec1 Oct 15, 2018

README.md

Joust

Travis GitHub release

Hearthstone replays in your browser, written in Typescript with React.

Requirements

  • Node.js ~v8 (v4.5 should also work, but is not officially supported)
  • Build system: npm install -g gulp webpack
  • Development: npm install -g electron-prebuilt gulp webpack
  • yarn: npm install -g yarn

Building

$ yarn --pure-lockfile
$ gulp compile

Usage

<div id="joust-container"></div>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/react/15.4.0/react.min.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/react/15.4.0/react-dom.min.js"></script>
<link rel="stylesheet" href="joust.css"></link>
<script type="text/javascript" src="joust.js"></script>
<script type="text/javascript">
	Joust.launcher("joust-container")
		.height(500)
		.width(500)
		.fromUrl("//example.org/brawl.hsreplay");
</script>

Full documentation.

Joust does not do any polyfilling and expects the globals Promise and fetch to be available.

Development

$ yarn run dev

License

Copyright © HearthSim. All Rights Reserved.

Third party assets

  • The Font Awesome font is licensed under the SIL OFL 1.1.
  • The Font Awesome style code is licensed under the MIT license.
  • Some Hearthstone textures are copyright © Blizzard Entertainment

Community

This is a HearthSim project. All development happens on our IRC channel #hearthsim on Freenode.