https://github.com/cherry/shieldsio-steam-workshop
Shields.io endpoint to display subscribers/favourites on a Steam Workshop addon
https://github.com/cherry/shieldsio-steam-workshop
shields shields-endpoint shieldsio shieldsio-endpoint
Last synced: 3 months ago
JSON representation
Shields.io endpoint to display subscribers/favourites on a Steam Workshop addon
- Host: GitHub
- URL: https://github.com/cherry/shieldsio-steam-workshop
- Owner: Cherry
- License: mit
- Created: 2019-02-06T01:03:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-09T19:15:12.000Z (over 6 years ago)
- Last Synced: 2025-03-25T01:46:52.528Z (7 months ago)
- Topics: shields, shields-endpoint, shieldsio, shieldsio-endpoint
- Size: 2.93 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shields.io for [Steam Workshop Addons](https://steamcommunity.com/workshop/) 
This is a custom endpoint to allow the display of Steam Workshop addon statistics, such as subcriptions, and favourites. It makes use of [shields.io's Endpoint feature](https://shields.io/#/endpoint).
## Usage
- Endpoint: `https://shieldsio-steam-workshop.jross.me/109643223`
- Endpoint encoded: `https%3A%2F%2Fshieldsio-steam-workshop.jross.me%2F109643223`
- Using shields.io `endpoint`/`url`: `https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-steam-workshop.jross.me%2F109643223&style=for-the-badge`
- Result: 
The endpoint expects an ID, and then an optional type such as `subscriptions`, or `favourites`. Examples can be seen below.
See [shields.io's endpoint](https://shields.io/#/endpoint) for full documentation.
## Examples
Show total unique number of subcribers:
```
https://shieldsio-steam-workshop.jross.me/109643223
```
Show total unique number of subcribers (with text):
```
https://shieldsio-steam-workshop.jross.me/109643223/subscriptions-text
```
Show total number of times the addon has been favourited:
```
https://shieldsio-steam-workshop.jross.me/109643223/favourites
```
Show total number of times the addon has been favourited (with text):
```
https://shieldsio-steam-workshop.jross.me/109643223/favourites-text
```
