Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knutkirkhorn/cryptoblades-stamina-notifier
🏃 Get notified when stamina thresholds are reached for CryptoBlades characters
https://github.com/knutkirkhorn/cryptoblades-stamina-notifier
binance-smart-chain blockchain character cryptoblades discord docker hecochain nodejs notification notifier stamina
Last synced: about 1 month ago
JSON representation
🏃 Get notified when stamina thresholds are reached for CryptoBlades characters
- Host: GitHub
- URL: https://github.com/knutkirkhorn/cryptoblades-stamina-notifier
- Owner: knutkirkhorn
- License: mit
- Created: 2021-08-08T13:26:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T12:06:57.000Z (almost 2 years ago)
- Last Synced: 2024-04-23T23:05:14.455Z (9 months ago)
- Topics: binance-smart-chain, blockchain, character, cryptoblades, discord, docker, hecochain, nodejs, notification, notifier, stamina
- Language: JavaScript
- Homepage:
- Size: 156 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cryptoblades-stamina-notifier
> 🏃 Get notified when stamina thresholds are reached for [CryptoBlades](https://www.cryptoblades.io) characters
[](https://hub.docker.com/r/knutkirkhorn/cryptoblades-stamina-notifier) [](https://hub.docker.com/r/knutkirkhorn/cryptoblades-stamina-notifier)
Notifies on Discord if stamina thresholds are reached for given [CryptoBlades](https://www.cryptoblades.io) characters. Fetches stamina and character information from smart contracts on the [Binance Smart Chain](https://www.binance.org/en/smartChain), [Huobi ECO Chain](https://www.hecochain.com) or [OKExChain](https://www.okex.com/okexchain). It notifies to a Discord channel using [Discord Webhooks](https://discord.com/developers/docs/resources/webhook).
## Usage
### Within a Docker container
#### From Docker Hub Image
This will pull the image from [Docker Hub](https://hub.docker.com/) and run the image with the provided configuration for web hooks as below. It's required to provide account addresses, names and the Webhook URL or both the Webhook ID and token.
```sh
# Providing a Discord Webhook URL and a single account
$ docker run -d -e DISCORD_WEBHOOK_URL= \
-e ADDRESSES= \
-e ACCOUNT_NAMES="Main" \
knutkirkhorn/cryptoblades-stamina-notifier
# Providing a Discord Webhook URL and multiple accounts
$ docker run -d -e DISCORD_WEBHOOK_URL= \
-e ADDRESSES=, \
-e ACCOUNT_NAMES="First, Second" \
knutkirkhorn/cryptoblades-stamina-notifier
```
#### From source code
```sh
# Build container from source
$ docker build -t cryptoblades-stamina-notifier .
# Providing a single account
$ docker run -d -e DISCORD_WEBHOOK_URL= \
-e ADDRESSES= \
-e ACCOUNT_NAMES="Main" \
cryptoblades-stamina-notifier
# Providing multiple accounts
$ docker run -d -e DISCORD_WEBHOOK_URL= \
-e ADDRESSES=, \
-e ACCOUNT_NAMES="First, Second" \
cryptoblades-stamina-notifier
```
### Outside of a Docker container
```sh
# Install
$ npm install
# Run
$ npm start
```
### Environment variables
Provide these with the docker run command or store these in a `.env` file.
- `DISCORD_WEBHOOK_URL`
- URL to the Discord Webhook containing both the ID and the token
- Format: `DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks//`
- `DISCORD_WEBHOOK_ID`
- ID for the Discord Webhook
- `DISCORD_WEBHOOK_TOKEN`
- Token for the Discord Webhook
- `WAIT_TIMEOUT` ***(optional)***
- The time interval in milliseconds between each check of character staminas.
- Default: `3600000` (60 minutes)
- `STAMINA_THRESHOLD` ***(optional)***
- The stamina threshold for when to notify.
- Default: `160`
- `NETWORK` ***(optional)***
- The blockchain network used for smart contract interaction.
- Default: `bsc` (Binance Smart Chain)
- Supported networks:
- `bsc`
- `heco`
- `okex`
- `BLOCKCHAIN_PROVIDER` ***(optional)***
- The URI for the blockchain provider used for smart contract interaction.
- Default: The selected network's blockchain provider
- `ADDRESSES`
- The blockchain address(es) used for checking character staminas.
- `ACCOUNT_NAMES` ***(optional)***
- Names for the account(s) used for better knowing for which account the stamina threshold was reached. This can be anything and are just used in the Discord message.
- Needs to be in the same order as the addresses.
- If not provided it will create `1st`, `2nd`, `3rd` etc. for the length of provided addresses.
- `WIN_PERCENTAGE_THRESHOLD` ***(optional)***
- A threshold for calculated fight win percentages. Notifies if percentage is above given threshold.
- This is only used if `WEAPON_IDS` are provided.
- Default: `98`
- `WEAPON_IDS` ***(optional)***
- IDs for the weapons used for calculating win percentages for the different opponents.
- Needs to be in the same order as the addresses.