Skip to content

Burning Knight Cheat Sheet is an interactive React web app that displays item descriptions.

Notifications You must be signed in to change notification settings

bfrymire/burning-knight-cheat-sheet

Repository files navigation

BKCS Logo

Burning Knight Cheat Sheet

Burning Knight Cheat Sheet is an interactive item wiki to be used alongside the game Burning Knight.

Setup

The Burning Knight item images and data are pulled from the BkWikiData.

GitHub REST API is rate limited. By providing your auth token, you're able to increase the number of requests per hour.

Click to learn more about GitHub's Personal Access Tokens.

  1. Create a .env file and add your GitHub Personal Access Token:
GITHUB_PAT=""
  1. Install Python dependancies. It's recommended to use a virtual environment like venv or virtualenv:
pip install -r ./src/scripts/requirements.txt
  1. Run main.py to download images and JSON data:
python ./src/scripts/main.py
  1. Install Node Modules:
yarn install
  1. You're all set!
yarn preview

Attributions

Disclaimer

Burning Knight Cheat Sheet is not endorced or affiliated with the game Burning Knight, developer Rexcellent Games, or publisher 2Awesome Studio.

All images and data are property of their respective owners.

About

Burning Knight Cheat Sheet is an interactive React web app that displays item descriptions.

Topics

Resources

Stars

Watchers

Forks