You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-23Lines changed: 23 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@
14
14
-[Usage](#usage)
15
15
-[Contributors](#contributors)
16
16
17
-
This package provides an easy way to get details from the steam api service. The services it can access are:
17
+
This package provides an easy way to get details from the Steam API service. The services it can access are:
18
18
19
19
-`ISteamNews`
20
20
-`IPlayerService`
@@ -42,13 +42,13 @@ Once that is finished, add the service provider to `config/app.php`
42
42
43
43
> The alias to Steam is already handled by the package.
44
44
45
-
Lastly, publish the config file. You can get your API key from [Steam](http://steamcommunity.com/dev/apikey)
45
+
Lastly, publish the config file. You can get your API key from [Steam](http://steamcommunity.com/dev/apikey).
46
46
47
47
php artisan vendor:publish
48
48
49
49
## Usage
50
50
51
-
Each service from the steam api has it's own methods you can use.
51
+
Each service from the Steam API has its own methods you can use.
52
52
53
53
-[Global](#global)
54
54
-[News](#news)
@@ -59,7 +59,7 @@ Each service from the steam api has it's own methods you can use.
59
59
-[Group](#group)
60
60
61
61
### Global
62
-
These are methods that are available to each service
62
+
These are methods that are available to each service.
63
63
64
64
#### convertId
65
65
This will convert the given steam ID to each type of steam ID (64 bit, 32 bit and steam ID3).
@@ -89,7 +89,7 @@ Steam::news()
89
89
```
90
90
91
91
#### GetNewsForApp
92
-
This method will get the news articles for a given app id. It has three parameters.
92
+
This method will get the news articles for a given app ID. It has three parameters.
93
93
94
94
##### Arguments
95
95
@@ -112,14 +112,14 @@ maxlength | int | The maximum number of characters to return | No | null
112
112
### Player
113
113
The [Player Service](https://developer.valvesoftware.com/wiki/Steam_Web_API#GetOwnedGames_.28v0001.29) is used to get details on players.
114
114
115
-
When instantiating the player class, you are required to pass a steamId or steam community ID.
115
+
When instantiating the player class, you are required to pass a steamId or Steam community ID.
116
116
117
117
```php
118
118
Steam::player($steamId)
119
119
```
120
120
121
121
#### GetSteamLevel
122
-
This method will return the level of the steam user given. It simply returns the integer of their current level.
122
+
This method will return the level of the Steam user given. It simply returns the integer of their current level.
123
123
124
124
125
125
> Example Output: [GetSteamLevel](./examples/player/GetSteamLevel.txt)
@@ -131,13 +131,13 @@ This will return a Syntax\Containers\Player_Level object with full details for t
131
131
> Example Output: [GetPlayerLevelDetails](./examples/player/GetPlayerLevelDetails.txt)
132
132
133
133
#### GetBadges
134
-
This call will give you a list of the badges that the player currently has. There is currently no schema for badges so all you will get is the id and details.
134
+
This call will give you a list of the badges that the player currently has. There is currently no schema for badges, so all you will get is the ID and details.
135
135
136
136
137
137
> Example Output: [GetBadges](./examples/player/GetBadges.txt)
138
138
139
139
#### GetOwnedGames
140
-
GetOwnedGames returns a list of games a player owns along with some playtime information, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (ie the WebAPI key you are using is linked to the steamid you are requesting).
140
+
GetOwnedGames returns a list of games a player owns along with some playtime information, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (i.e. the WebAPI key you are using is linked to the steamID you are requesting).
141
141
142
142
##### Arguments
143
143
@@ -151,7 +151,7 @@ appIdsFilter | array | An array of appIds. These will be the only ones returned
151
151
> Example Output: [GetOwnedGames](./examples/player/GetOwnedGames.txt)
152
152
153
153
#### GetRecentlyPlayedGames
154
-
GetRecentlyPlayedGames returns a list of games a player has played in the last two weeks, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (ie the WebAPI key you are using is linked to the steamid you are requesting).
154
+
GetRecentlyPlayedGames returns a list of games a player has played in the last two weeks, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (i.e. the WebAPI key you are using is linked to the steamID you are requesting).
155
155
156
156
##### Arguments
157
157
@@ -176,7 +176,7 @@ appId| int | The game to check for | Yes |
176
176
### User
177
177
The [User](https://developer.valvesoftware.com/wiki/Steam_Web_API#GetFriendList_.28v0001.29) WebAPI call is used to get details about the user specifically.
178
178
179
-
When instantiating the user class, you are required to pass a steamId or steam community ID.
179
+
When instantiating the user class, you are required to pass a steamID or Steam community ID.
180
180
181
181
```php
182
182
Steam::user($steamId)
@@ -204,7 +204,7 @@ This will return details on the user.
204
204
205
205
Name | Type | Description | Required | Default
206
206
-----|------|-------------|----------|---------
207
-
steamId| int[] | An array of (or singular) steam id(s) to get details for | No | Steam id passed to user()
207
+
steamId| int[] | An array of (or singular) steam ID(s) to get details for | No | Steam ID passed to user()
@@ -241,14 +241,14 @@ steamId| int[] | An array of (or singular) steam id(s) to get details for | No
241
241
### User Stats
242
242
The [User Stats](https://developer.valvesoftware.com/wiki/Steam_Web_API#GetPlayerAchievements_.28v0001.29) WebAPI call is used to get details about a user's gaming.
243
243
244
-
When instantiating the user stats class, you are required to pass a steamId or steam community ID.
244
+
When instantiating the user stats class, you are required to pass a steamID or Steam community ID.
245
245
246
246
```php
247
247
Steam::userStats($steamId)
248
248
```
249
249
250
250
#### GetPlayerAchievements
251
-
Returns a list of achievements for this user by app id.
251
+
Returns a list of achievements for this user by app ID.
252
252
253
253
##### Arguments
254
254
@@ -260,38 +260,38 @@ appId| int | The id of the game you want the user's achievements in | Yes |
260
260
> Example Output: [GetPlayerAchievements](./examples/user/stats/GetPlayerAchievements.txt)
261
261
262
262
#### GetGlobalAchievementPercentagesForApp
263
-
This method will return a list of all chievements for the specified game and the percentage that each achievement has been unlocked.
263
+
This method will return a list of all achievements for the specified game and the percentage of all users that have unlocked each achievement.
264
264
265
265
##### Arguments
266
266
267
267
Name | Type | Description | Required | Default
268
268
-----|------|-------------|----------|---------
269
-
appId| int | The id of the game you want the user's achievements in | Yes |
269
+
appId| int | The ID of the game you want the user's achievements in | Yes |
270
270
271
271
272
272
> Example Output: [GetGlobalAchievementPercentagesForApp](./examples/user/stats/GetGlobalAchievementPercentageForApp.txt)
273
273
274
274
#### GetUserStatsForGame
275
-
Returns a list of achievements for this user by app id.
275
+
Returns a list of achievements for this user by app ID.
276
276
277
277
##### Arguments
278
278
279
279
Name | Type | Description | Required | Default
280
280
-----|------|-------------|----------|---------
281
-
appId| int | The id of the game you want the user's achievements in | Yes |
281
+
appId| int | The ID of the game you want the user's achievements in | Yes |
282
282
all| boolean | If you want all stats and not just the achievements set to true.| No | FALSE
283
283
284
284
285
285
> Example Output: [GetUserStatsForGame](./examples/user/stats/GetUserStatsForGame.txt) | [GetUserStatsForGame (all)](./examples/user/stats/GetUserStatsForGameAll.txt)
286
286
287
287
#### GetSchemaForGame
288
-
Returns a list of game details including achievements and stats.
288
+
Returns a list of game details, including achievements and stats.
289
289
290
290
##### Arguments
291
291
292
292
Name | Type | Description | Required | Default
293
293
-----|------|-------------|----------|---------
294
-
appId| int | The id of the game you want the details for. | Yes |
294
+
appId| int | The ID of the game you want the details for. | Yes |
295
295
296
296
297
297
> Example Output: [GetSchemaForGame](./examples/user/stats/GetSchemaForGame.txt)
@@ -316,12 +316,12 @@ appIds| int[] | The ids of the games you want details for | Yes |
316
316
> Example Output: [appDetails](./examples/app/appDetails.txt)
317
317
318
318
#### GetAppList
319
-
This method will return an array of app objects directly from steam. It includes the appId and the app name.
319
+
This method will return an array of app objects directly from Steam. It includes the appID and the app name.
320
320
321
321
> Example Output: [GetAppList](./examples/app/GetAppList.txt)
322
322
323
323
### Group
324
-
This service is used to get details on a steam group.
324
+
This service is used to get details on a Steam group.
325
325
326
326
```php
327
327
Steam::group()
@@ -334,7 +334,7 @@ This method will get the details for a group.
334
334
335
335
Name | Type | Description | Required | Default
336
336
-----|------|-------------|----------|---------
337
-
group| string or int | The id or the name of the group. | Yes
337
+
group| string or int | The ID or the name of the group. | Yes
0 commit comments