https://github.com/xiyang6666/xbox-query

用于查询xbox玩家信息的 NodeJS 包 / a NodeJS package for querying Xbox player information
https://github.com/xiyang6666/xbox-query

Last synced: 2 months ago
JSON representation

用于查询xbox玩家信息的 NodeJS 包 / a NodeJS package for querying Xbox player information

• Host: GitHub
• URL: https://github.com/xiyang6666/xbox-query
• Owner: XiYang6666
• Created: 2024-02-02T15:49:22.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-07-28T10:01:13.000Z (5 months ago)
• Last Synced: 2024-10-29T15:33:47.647Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 75.2 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# xbox-query

一个用于查询 xbox 玩家信息的 工具/API，基于 node.js 。

## CLI 使用方法

### 安装

该工具需要 node.js 运行环境，请确保在使用此工具前安装了 nodejs。

```bash

npm install -g xbox-query

```

### 登录 Xbox 账号

根据提示输入相应内容

```bash

xbox-query login

```

### 查询玩家信息

通过`xuid`或者`gamertag`来获取玩家信息。

```bash

xbox-query query 

```

## API

`xbox-query` 通常与 `@xboxreplay/xboxlive-auth` 的 `authenticate` 连用。为方便起见，`xbox-query` 直接从依赖中导出 `authenticate`，因此你可以直接从`xbox-query`导入它。

以下为主页函数与类型别名的伪声明代码：

```ts

// authenticate 与 CredentialsAuthenticateResponse, 直接导入来自 @xboxreplay/xboxlive-auth

import { CredentialsAuthenticateResponse, authenticate } from "@xboxreplay/xboxlive-auth";

type GamerProfile = {

    xuid: string;

    GameDisplayName: string;

    Gamertag: string;

    GameDisplayPicRaw: string;

    Gamerscore: number;

    TenureLevel: number;

};

/**

 * 获取指定玩家信息

 *

 * @param {CredentialsAuthenticateResponse} auth_data 请求用到的 token

 * @param {string} tag 目标玩家的 gamertag 或者 xuid

 * @return {*}  {Promise} 玩家信息

 */

function query(auth_date: CredentialsAuthenticateResponse, tag: string): Promise;

```

以下为示例代码。此代码将会登录`[email protected]`的 Xbox 账号并使用它的 token ，然后获取 `xuid` 为 `123456789` 玩家的信息。

```js

import { authenticate, query } from "xbox-query";

authenticate("[email protected]", "password").then(data => {

    console.log(

        query(data, "123456789").then(result => {

            console.log(result);

        })

    );

});

```