diff --git a/README.md b/README.md new file mode 100644 index 0000000..619c9fc --- /dev/null +++ b/README.md @@ -0,0 +1,139 @@ +# Hoyolab Auto Daily Check In + +Today's check in status: +[![If you see this text, chances are the automation hasn't run. Do your setup below!](../../actions/workflows/login.yml/badge.svg)](../../actions/workflows/login.yml) + +Repository version: +[![Do your setup!](../../actions/workflows/version.yml/badge.svg)](../../actions/workflows/version.yml) + +## Table of Contents + +- [Getting your cookie](#getting-your-cookie) +- [Usage](#usage) +- [Multiple Accounts](#multiple-accounts) +- [Discord Webhook](#discord-webhook) +- [FAQ](#faq) + - [Is this safe?](#is-this-safe) + - [How to update my (fork) repository version?](#how-to-update-my-fork-repository-version) + - [Error not logged in](#error-not-logged-in) + - [I have other issues](#i-have-other-issues) + +## Getting your cookie + +You have to check in manually first to get your cookie, follow these steps (click to open screenshot): + +1. Open [SKPORT Arknights: Endfield Daily Sign In](https://game.skport.com/endfield/sign-in) and login if you haven't (obviously) + +2.
+ Open dev tool (Ctrl+Shift+I or right click anywhere > Inspect) + image +
+ +4.
+ For Chromium users, click on the Application tab. If not found, click on the arrow. + image +
+
+ For Firefox/Gecko-based browsers, click on the Storage tab. + image +
+ +5.
+ Just like the screenshot above, click on Local Storage and look for `SK_OAUTH_CRED_KEY` + image +
+ +6.
+ Copy the value by clicking on it, then selecting the text below. Or just double-click and Ctrl+C + image +
+ +7. That's your auth token, keep it save and do NOT share it with anyone! + +## Usage + +1. [Fork this repo](../../fork) +2. Open your fork repository +3.
+ Go to Settings > Secrets and variables > Actions, Click on New repository secrets + image +
+ +5.
+ + Insert name with CRED and secret with + your token, then click Add secret. You can input as many accounts, separate it with a new line (Enter). + + image +
+ +7.
+ + For the first day, you have to trigger this manually. + Simply go HERE and click on Run workflow + + +
+ +9.
+ Refresh the page, wait for 15-25 secs, and see if it ran successfully. You should now see the check in status on top of README. + +
+ +10. You're set! Hop on your game the next day and see if you got the rewards + +## Multiple Accounts + +
+ To add other accounts, you can add another token in a new line like below. + image +
+ +## Discord Webhook + +You may use Discord webhook to send notifications to your channel! + +1.
+ Go to channel settings + +
+ +2.
+ Go to Integrations and click Create Webhook + +
+ +3.
+ You can edit the name and picture freely, then Copy Webhook URL + +
+ +4.
+ Create a new repository variable named DISCORD_WEBHOOK with value of the webhook URL + +
+ +5.
+ (Optional) If you want to be tagged on check in, add `DISCORD_USER` variable with your Discord ID. + + +
+ +6. You may trigger the check in manually and see if the messages got sent + +## FAQ + +### Is this safe? + +It is still unknown whether automated daily log in is bannable for Arknights Endfield since its just a few days after release, use at your own risk! I won't be responsible if anything happens with your account. + +### How to update my (fork) repository version? + +
+Go to your repository and click Sync fork + +
+ +### I have other issues + +To the [Issues page](https://github.com/sglkc/hoyolab-auto-daily/issues)