GemShell

Appearance

Steam User Info ​

Get information about the current Steam user.

Methods ​

getSteamID() ​

Get the user's 64-bit Steam ID.

javascript
const steamId = await steam.getSteamID();
// '76561198012345678'

getPersonaName() ​

Get the user's display name.

javascript
const name = await steam.getPersonaName();
// 'PlayerOne'

getPlayerSteamLevel() ​

Get the user's Steam level.

javascript
const level = await steam.getPlayerSteamLevel();
// 42

getAppID() ​

Get the current app's Steam ID.

javascript
const appId = await steam.getAppID();
// 480 (or your app ID)

Friends ​

getFriendCount() ​

Get number of friends.

javascript
const count = await steam.getFriendCount();

getFriends(max) ​

Get friend list with names.

javascript
const friends = await steam.getFriends(10);
// [{ steamId: '765...', name: 'Friend1' }, ...]

getFriendByIndex(index, flags) ​

Get friend Steam ID by index.

javascript
const friendId = await steam.getFriendByIndex(0, 0xFFFF);

getFriendPersonaName(index) ​

Get friend's display name by index.

javascript
const name = await steam.getFriendPersonaName(0);
// 'Friend1'

TIP

Use getFriendByIndex() to get the Steam ID, then use getFriendPersonaName() with the same index.

getFriendPersonaState(steamId) ​

Get friend's online status.

javascript
const state = await steam.getFriendPersonaState('76561198012345678');
// 0: Offline, 1: Online, 2: Busy, 3: Away, 4: Snooze, 5: Looking to Trade, 6: Looking to Play

getFriendGamePlayed(steamId) ​

Get what game a friend is currently playing.

javascript
const game = await steam.getFriendGamePlayed('76561198012345678');
// { appId: 480, ... } or null if not playing

requestUserInformation(steamId) ​

Request user information to be loaded (for users not in friend list).

javascript
await steam.requestUserInformation('76561198012345678');

Avatars ​

getSmallFriendAvatar(steamId) ​

Get small (32x32) avatar handle.

javascript
const handle = await steam.getSmallFriendAvatar('76561198012345678');

getMediumFriendAvatar(steamId) ​

Get medium (64x64) avatar handle.

javascript
const handle = await steam.getMediumFriendAvatar('76561198012345678');

getLargeFriendAvatar(steamId) ​

Get large (128x128) avatar handle.

javascript
const handle = await steam.getLargeFriendAvatar('76561198012345678');

getImageRGBA(handle) ​

Get avatar image data as RGBA buffer.

javascript
const imageData = await steam.getImageRGBA(handle);
// Uint8Array of RGBA pixel data

Examples ​

Display User Info ​

javascript
async function showUserInfo() {
  const name = await steam.getPersonaName();
  const level = await steam.getPlayerSteamLevel();
  const steamId = await steam.getSteamID();
  
  document.getElementById('user-info').innerHTML = `
    <p>Welcome, ${name}!</p>
    <p>Steam Level: ${level}</p>
    <p>Steam ID: ${steamId}</p>
  `;
}

Friend Leaderboard ​

javascript
async function showFriendScores(scores) {
  const friends = await steam.getFriends(100);
  
  const friendScores = friends
    .filter(f => scores[f.steamId])
    .map(f => ({ name: f.name, score: scores[f.steamId] }))
    .sort((a, b) => b.score - a.score);
  
  return friendScores;
}

Online Friends ​

javascript
async function getOnlineFriends() {
  const count = await steam.getFriendCount();
  const online = [];
  
  for (let i = 0; i < count; i++) {
    const steamId = await steam.getFriendByIndex(i, 0xFFFF);
    const state = await steam.getFriendPersonaState(steamId);
    
    if (state >= 1 && state <= 6) {
      const name = await steam.getFriendPersonaName(i);
      online.push({ steamId, name, state });
    }
  }
  
  return online;
}