Splatoon WeChat Bot

English | 中文

Wechat bot for querying Splatoon 3 work (Salmon Run) results.

Contributions are welcome! Feel free to open an issue or a pull request if you have any suggestions or improvements to make.

Usage

Install dependencies

npm install

Obtain a session token of your Nintendo Switch Online (NSO) account

You can use nxapi to get it.

npm install -g nxapi
nxapi nso auth

Follow the instructions to log in to your NSO account and obtain the session token.

Configure the bot

Create a .env file in the root directory of the project with the following content:

# NSO session token
NT_SESSION_TOKEN="your_session_token_here"

# WeChat nickname of admin
# (optional).
ADMIN_WECHAT_NICKNAME="wechat_nickname_here"

# Names of groups to respond to
# (optional, by default the bot will respond to
#  all groups)
ROOM_NAMES="room_1,room_2"

# Query throttling in milliseconds
# (optional, default is 10000)
QUERY_THROTTLE=10000

# Data save directory
# (optional, default is './data/work/')
DATA_SAVE_PATH="./data/work/"

# Show the username of the player in statistics
# (optional, default is false)
SHOW_PLAYER_NAME=true

# Timezone
# (optional, default is 'Asia/Shanghai')
TIMEZONE="America/New_York"

# Language
# (optional, default is account language)
LANGUAGE="zh-CN"

# Scoring function for ranking
# (optional, default:
#   {goldDeliver} + 0.5 * {goldAssist}
#   + 0.005 * {deliver} + {defeatEnemy}
#   + 2 * ({rescue} - {death})
# )
# The following variables can be used:
#   {goldDeliver} - number of golden eggs delivered
#   {goldAssist} - number of golden eggs assisted
#   {deliver} - number of red eggs delivered
#   {defeatEnemy} - number of enemies defeated
#   {rescue} - number of players rescued
#   {death} - number of deaths
SCORING_FUNCTION="..."

# Query last work's detail command format
# Use '{@selfName}' to represent '@bot_nickname'
# (optional, default is '{@selfName}')
QUERY_LAST_WORK_COMMAND_FORMAT="{@selfName}"

# Query work schedule command format
# (optional, default is '{@selfName} schedule')
QUERY_SCHEDULE_COMMAND_FORMAT="{@selfName} schedule"

Run the bot

npm start

Alternatively, you can run the bot with Docker.

docker run -it \
    -v $(pwd)/.env:/app/.env \
    -v $(pwd)/data:/app/data \
    -v $(pwd)/credentials:/app/credentials \
    liang2kl/splatoon-bot-wechat:latest

You will need to scan the QR code to log in to WeChat. Your account must be real-name verified with a credit/debit card in order to login successfully.

Use the bot

In the designated group chats, use the commands you set in your enviroment or use the default commands to interact with the bot. @bot_nickname is the nickname of the bot in the group chat.

Command	Default	Description
`QUERY_LAST_WORK_COMMAND_FORMAT`	`@bot_nickname`	Query the latest Salmon Run results
`QUERY_SCHEDULE_COMMAND_FORMAT`	`@bot_nickname schedule`	Query the upcoming Salmon Run schedule

You can control the bot by sending the following commands using the admin WeChat account:

Command	Description
`/splatoon stop`	Stop the bot from responding to queries
`/splatoon start`	Resume the bot