PHPackages                             randomhost/steamsignature - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Image & Media](/categories/media)
4. /
5. randomhost/steamsignature

ActiveLibrary[Image & Media](/categories/media)

randomhost/steamsignature
=========================

Displays the online status of Steam players as PNG image.

1.0.1(2y ago)5141BSD-3-ClausePHPPHP ~7.3

Since Sep 17Pushed 2y ago1 watchersCompare

[ Source](https://github.com/randomhost/steamsignature)[ Packagist](https://packagist.org/packages/randomhost/steamsignature)[ Docs](https://github.random-host.tv)[ RSS](/packages/randomhost-steamsignature/feed)WikiDiscussions main Synced 2mo ago

READMEChangelog (9)Dependencies (2)Versions (11)Used By (0)

[![Build Status](https://github.com/randomhost/steamsignature/actions/workflows/php.yml/badge.svg)](https://github.com/randomhost/steamsignature/actions/workflows/php.yml)

randomhost/steamsignature
=========================

[](#randomhoststeamsignature)

- [1. Purpose](#1-purpose)
- [2. Example](#2-example)
- [3. Requirements](#3-requirements)
- [4. Installation](#4-installation)
- [5. Usage](#5-usage)
- [6. License](#6-license)

1. Purpose
----------

[](#1-purpose)

This package reads the [Steam Web-API](https://developer.valvesoftware.com/wiki/Steam_Web_API) and [community XML data](https://partner.steamgames.com/documentation/community_data) of Valve's Steam platform and displays the current online status of players as PNG image, designed to be used in forum and blog signatures.

The included link target method detects whether the player is currently playing on a multiplayer server and returns either the URL to the player's steam profile or the URL for joining the game using the visitor's locally installed Steam client if this is supported by the game.

2. Example
----------

[](#2-example)

[![Example Signature](src/data/images/example.png)](https://steamcommunity.com/id/randomhosttv)

3. Requirements
---------------

[](#3-requirements)

- PHP 8.x
- `mbstring` extension for handling international characters and emojis
- `GD` extension for rendering the images
- [Composer](https://getcomposer.org)
- basic knowledge of executing shell commands on a server

**Note:** The only **officially** supported way to install this package is via Composer. However, it is theoretically possible to install PHP 8 and Composer on a local computer, run the installation there and then upload the `vendor`folder created by Composer to the server, in case shell access is not available.

4. Installation
---------------

[](#4-installation)

**Important:** This package uses the [Composer](https://getcomposer.org) dependency manager for PHP to check system requirements and to install package dependencies. Please make sure it is installed before trying to use this package.

The following example assumes that your web server is running under the user account `www-data`, that `composer` is installed into the system `$PATH`, and that you have a working `sudo` setup to run shell commands as a different user.

In this case, you simply have to run this command within the same directory which contains this `README.md` on your server:

```
sudo -u www-data composer install
```

5. Usage
--------

[](#5-usage)

A basic approach at using this package could look like this:

```