sts-daily-climb
v1.0.5
Published
An API to access data used by Slay the Spire's Daily Climb to generate daily runs.
Downloads
18
Readme
Daily Climb Node API
An API to access data used by Slay the Spire's Daily Climb to generate daily runs.
Install
yarn add sts-daily-climb
# or
npm install --save sts-daily-climb
Documentation
Documentation on how to use the package is available here
Development
Requirements
- Node >= v12.16.3
- yarn >= 1.12.1
- A steam account that owns a copy of Slay the Spire
Build
# Write steam account information to `.env`
# Replace [your_steam_username] with your steam username
# and [your_steam_password] with your steam password.
# Set HAS_STEAM_GUARD to true if you have steam guard enable, false otherwise
#
# example:
# echo STEAM_USERNAME=example_user > .env
# echo STEAM_PASSWORD=P@55W0RD >> .env
# echo HAS_STEAM_GUARD=true >> .env
#
echo STEAM_USERNAME=[your_steam_username] > .env
echo STEAM_PASSWORD=[your_steam_password] >> .env
echo HAS_STEAM_GUARD=[true|false] >> .env
# Install Node dependencies
yarn
# Download game files and compile TypeScript to JavaScript
#
# Note: If your account has Steam Guard enabled, you will be prompted
# to enter you steam guard code. If the game files are already installed,
# they will not be re-downloaded
yarn build