truckersmp/steam-api

Laravel 5 的 steam-api 客户端 - TruckersMP

2.0.16.2 2020-12-03 16:57 UTC

This package is auto-updated.

Last update: 2024-09-07 02:23:34 UTC


README

Join the chat at https://gitter.im/truckersmp/Steam

Build Status Scrutinizer Code Quality Latest Stable Version Total Downloads License

对于 Laravel 4,请查看 Laravel 4 分支上的文档 Laravel 4 branch

此包提供了一种简单的方法来获取 Steam API 服务的详细信息。它可以访问的服务包括:

  • ISteamNews
  • IPlayerService
  • ISteamUser
  • ISteamUserStats
  • ISteamApp

安装

首先使用 composer 安装此包。

"require": {
	"truckersmp/steam-api": "2.0.*"
}

然后,从终端更新 composer。

composer update truckersmp/steam-api

或者,您可以从命令行运行 "composer require truckersmp/steam-api:dev-master"。

注意:如果您正在使用 Laravel 5.5,则以下步骤是不必要的。此包支持 Laravel Package Discovery

完成后,将服务提供者添加到 config/app.php

'Syntax\SteamApi\SteamApiServiceProvider',

Steam 的别名已由包处理。

最后,发布配置文件。您可以从 Steam 获取您的 API 密钥。

php artisan vendor:publish

使用

Steam API 的每个服务都有自己的方法可以使用。

全局

这些是每个服务可用的方法。

convertId

此方法将给定的 steam ID 转换为每种类型的 steam ID(64 位、32 位和 steam ID3)。

参数

可能的格式为 ID64、id64、64、ID32、id32、32、ID3、id3 和 3。

示例用法
Steam::convertId($id, $format);

示例输出: convertId

新闻

使用 Steam News 网络API获取游戏的文章。

Steam::news()

GetNewsForApp

此方法将获取给定应用 ID 的新闻文章。它有三个参数。

参数
示例用法
<?php
	$news = Steam::news()->GetNewsForApp($appId, 5, 500)->newsitems;
?>

示例输出: GetNewsForApp

玩家

使用 Player Service 获取玩家的详细信息。

在实例化玩家类时,您需要传递一个 steamId 或 Steam 社区 ID。

Steam::player($steamId)

GetSteamLevel

此方法将返回给定 Steam 用户的级别。它只是返回他们当前级别的整数。

示例输出: GetSteamLevel

GetPlayerLevelDetails

这将返回一个 Syntax\Containers\Player_Level 对象,其中包含玩家级别的完整详细信息。

示例输出: GetPlayerLevelDetails

GetBadges

此调用将为您提供一个列表,其中包含玩家当前拥有的徽章。目前没有徽章的架构,因此您将仅获得 ID 和详细信息。

示例输出: GetBadges

GetOwnedGames

GetOwnedGames函数返回玩家拥有的游戏列表以及一些游戏时长信息,如果个人资料是公开的。除非您正在请求自己的个人信息(即您使用的WebAPI密钥与请求的steamID相关联),否则不支持私有、仅好友可见和其他隐私设置。

参数

示例输出:GetOwnedGames

GetRecentlyPlayedGames

GetRecentlyPlayedGames函数返回玩家在过去两周内玩过的游戏列表,如果个人资料是公开的。除非您正在请求自己的个人信息,否则不支持私有、仅好友可见和其他隐私设置。

参数

示例输出:GetRecentlyPlayedGames

IsPlayingSharedGame

IsPlayingSharedGame函数返回当前借阅账户正在玩此游戏的原主人的SteamID。如果游戏未被借出或借阅者当前没有玩此游戏,结果始终为0。

参数

示例输出:IsPlayingSharedGame

用户

User WebAPI调用用于获取特定用户的详细信息。

实例化用户类时,您至少需要传递一个steamId或Steam社区ID。

Steam::user($steamId)

ResolveVanityURL

这将返回用户显示名对应的详细信息。

参数
	$player = Steam::user($steamId)->ResolveVanityURL('gabelogannewell');

示例输出:ResolveVanityURL

GetPlayerSummaries

这将返回一个或多个用户的详细信息。

参数
	// One user
	$steamId = 76561197960287930;
	$player = Steam::user($steamId)->GetPlayerSummaries()[0];
	
	// Several users
	$steamIds = [76561197960287930, 76561197968575517]
	$players = Steam::user($steamIds)->GetPlayerSummaries();

示例输出:GetPlayerSummaries

GetFriendList

返回任何Steam用户的好友列表,前提是他的Steam社区个人资料可见性设置为“公开”。

参数

收集到好友列表后,如果summaries未设置为false,则通过GetPlayerSummaries传递。这使得您可以获取一组玩家对象。

示例输出:GetFriendList

GetPlayerBans

返回可能放置在提供的steam ID(s)上的禁令。

参数

示例输出:GetPlayerBans

用户统计

User Stats WebAPI调用用于获取有关用户游戏详情。

实例化用户统计数据类时,您需要传递一个steamID或Steam社区ID。

Steam::userStats($steamId)

GetPlayerAchievements

通过应用ID返回此用户的成就列表。

参数

示例输出:GetPlayerAchievements

GetGlobalAchievementPercentagesForApp

此方法将返回指定游戏中所有成就的列表以及解锁每个成就的所有用户的百分比。

参数

示例输出:GetGlobalAchievementPercentagesForApp

GetUserStatsForGame

通过应用ID返回此用户的成就列表。

参数

示例输出:GetUserStatsForGame | GetUserStatsForGame (all)

GetSchemaForGame

返回包含成就和统计数据在内的游戏详细信息列表。

参数

示例输出: GetSchemaForGame

应用

此区域将获取游戏的详细信息。

Steam::app()

appDetails

此功能获取游戏的所有详细信息。这是从游戏商店页面获取的大部分信息。

参数

示例输出: appDetails

GetAppList

此方法将从Steam直接返回一个应用对象数组。它包括应用ID和应用名称。

示例输出: GetAppList

此方法将获取包的详细信息。

Steam::package()

packageDetails

此功能获取包的所有详细信息。这是从包商店页面获取的大部分信息。

参数

示例输出: packageDetails

此服务用于获取Steam群的详细信息。

Steam::group()

GetGroupSummary

此方法将获取群的详细信息。

参数
示例用法
<?php
	$news = Steam::group()->GetGroupSummary('Valve');
?>

示例输出: GetGroupSummary

贡献者