https://github.com/trustmaster/cot-steam

Steam Achievements for Cotonti-powered gaming communities
https://github.com/trustmaster/cot-steam

Last synced: 23 days ago
JSON representation

Steam Achievements for Cotonti-powered gaming communities

• Host: GitHub
• URL: https://github.com/trustmaster/cot-steam
• Owner: trustmaster
• Created: 2012-10-23T13:41:31.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-09-13T07:25:37.000Z (over 11 years ago)
• Last Synced: 2024-10-15T21:29:50.231Z (2 months ago)
• Language: PHP
• Homepage: http://www.cotonti.com/extensions/gaming-clans/steam
• Size: 151 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Steam Achievements module for Cotonti

This module displays in-game achievements of your Cotonti website users utilizing [Steam API](http://api.steampowered.com) and [SteamCommunity](http://steamcommunity.com).

## Installation

1. Copy steam module into your Cotonti modules folder.

2. Install the module in Administration / Extensions.

3. Proceed to configuration.

## Configuration

1. Obtain your own [Steam API Key](http://steamcommunity.com/dev/apikey) and specify it in the module configuration.

2. Collect Steam appIDs for your games from [SteamCommunity](http://steamcommunity.com/apps), e.g. if the game URL looks like `http://steamcommunity.com/app/71270` then appID for the game is '71270'.

3. Collect SteamCommunity shortcuts for your games by visiting Global Achievements for those games, e.g. if the achievements URL looks like `http://steamcommunity.com/stats/FM2012/achievements/` then SteamCommunityName for the game is 'FM2012'.

4. Go to module configuration in Administration / Extensions / Steam and fill collected information in game configuration. Don't forget to specify default appID.

Every time you change configuration and add/remove games, Steam module synchronizes its database with SteamCommunity and obtains properties and descriptions for those games.

## Usage

This module installs a new extrafield for user profiles: SteamID. Add {USERS_PROFILE_STEAMID} it to your 'users.profile.tpl' file.

A user needs to specify his SteamID in profile for the module to start tracking their achievements. SteamID can be either a 64-bit SteamID (a big integer number) or a name part of Steam vanityURL. For example if your SteamCommmunity Profile URL looks like `http://steamcommunity.com/profiles/12345678901234567/` then your SteamID is '12345678901234567'. If your SteamCommmunity Profile URL looks like `http://steamcommunity.com/id/coolguy` then your SteamID (vanityURL) is 'coolguy'.

Once a user has specified his SteamID, the module starts synchronizing their achievements every time he comes back to the site from absence.

Add {USERS_DETAILS_STEAMBOX} tag to 'users.details.tpl' file to display user achievements on their public profile page.

The global stats URL is something like http://example.com/steam/ or http://example.com/index.php?e=steam depending on your site's URL settings.

## Customization

You can easily customize Steam module templates. In order to do so, copy files from 'modules/steam/tpl' folder to 'themes/your_theme/modules' folder and edit them there.

## Credits

* This module uses [PHP SteamAPI](https://github.com/MattRyder/SteamAPI) by Matt Ryder.

* This module was sponsored and tested by [FM Scout](http://www.fmscout.com/) community.