Git Product home page Git Product logo

tp-steam-friend-plugin's Introduction

Banner 2

GitHub release (latest by date) GitHub all releases GitHub issues

TouchPortal SteamFriend Plugin

Description

SteamFriend is a Plugin that allow you to see which your friend is online, offline, away etc.. and also see your own games too!

SteamFriend Actions and States

Actions

  • Currently This Plugin does Not have any actions

States

image

States Summary

  • Get Current Online, Offline, Aaway, Busy, Snooze and more!
  • Get Total Friends
  • Get Total Number of Friends in-Game (Any Game)
  • Get List User In-Game
  • Get My Own Icon
  • Get Current X Game maximum achievements
    • Maximum Achievements is What is the Maximum Number of Achievements that the game have
  • Get Current X Game Current Achievements
    • Curret X Game Achievements is whats the current Number of Achievements you've reached
  • Get Current X Game Achievement percent
    • Shows Percent of Current Achievements / Maximum Number of Achievements
  • Get Total X Game Playtime

Installation

  1. Go to Releases on the main page of this github.
  2. Make sure download right file for your system Mac-TouchPortalSteamPlugin.tpp is for macOS users and Win-TouchPortalSteamPlugin.tpp for Windows 10 users.
  3. After you have the file head over to touchportal app on your Mac/Win pc.
  4. On the top right click the wrench icon.
    image
  5. Click Import plugin-in... and select the .tpp file you've downloaded in step 2.
  6. Next we need to get an API Key to retrieve data from Steam.(All data is only transfered between Steam and you. I do not collect any data. Feel free to check my code!)
  7. Go to the following Steam website to attain an Steam API Key
    • Login to your steam account if you reach this login page:
      image
    • If are already logged in you will see the API key registration page:
      image
  8. For me i just entered TPSteamPlugin for the domain name and checked the box next to I agree to the Steam Web API Terms of Use and clicked the green register button.
    image
  9. After You Clicked Register it will generate your personal API Key. (You can comeback to the same page to revoke the API Key) image
  10. The API key that I got was F7E05969F64A0B5134FCB14B96063E60 (This Key is just a example It wont work for you!)
  11. Save the API key in Notepad for later use.
  12. On the same page click your profile picture in the top right.
    image
  13. Your profile page will look something simalar to this.
    image
  14. Copy highlighted 17 digit number SteamID in the URL and copy it to Notepad for later use like this:
    image
  15. Now that we have the API Key and your SteamID goto the TouchPortal App On Desktop again Click the cog icon. image
  16. This will open another window. image
  17. Click Plug-ins.
  18. You will see a drop-down menu next to the Import plug-in... Button, if not restart TouchPortal.
  19. Enter in the SteamID and the API Key into their respective fields. image
  20. After You inserted everything Click Save.
  21. After you've saved the settings you should go back to the settings again and select steam plugin you should see status shows Connected just like this:
    image

Demo

A Demo page that shows off some of the features and functionality of TouchPortal Plugin can be found Here. Once install it will look like the image below image

Import Demo Page

  1. Download demo page from Here.
    image
  2. Click "Manage Page..." button on Touch Portal Main Menu.
  3. Click "Import Page"
  4. Find the downloaded file steam-friends.tpz and click open
    image
  5. Click Yes when this pop-up appears
    ![image]
  6. Click Ok button to close the import confirmation page
    image
  7. You will now have a new page named steam-friends showing of most fuctions of the plugin. Note: Though the page in touch portal does look like it's not doing anything it is. You will see it update with infomation once you are using the app on a device.

tp-steam-friend-plugin's People

Contributors

cj2tech avatar killerboss2019 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

tp-steam-friend-plugin's Issues

Unable to connect to profile. Custom URL.

I have a Custom URL and I put in both that one and the profile numbers, but neither allowed the plugin to connect. I even generated two API keys but that didn't work either, and it's impossible for me to remove the Custom URL for some reason.

I would prefer not to, since I'm unsure if I would lose it completely, and the URL is my online handle for everything.

I also updated to desktop version 2.3.010, I don't know if that changes anything.

Suggestion: Documentation

This seems like a very cool plugin. It would be dope to have some example pictures oh how to use it and maybe a list of possible handles, variables, etc. Something like TP_Discord would be dope. Just hard to use this plugin with minimal documentation. Please, thank you, and keep up the awsome work

Game Library

I know its not 'Steam Friends' related.. but it is Steam related...

Any chance of being able to see our own game library with icons matching as well with options to launch said games ?

Plugins fails with "KeyError: 'achievements'"

13:49:10.491 - [ERROR] (Plugin Instance) Exception in thread Thread-3:
13:49:10.499 - [ERROR] (Plugin Instance) Traceback (most recent call last):
13:49:10.506 - [ERROR] (Plugin Instance)   File "threading.py", line 932, in _bootstrap_inner
13:49:10.513 - [ERROR] (Plugin Instance)   File "threading.py", line 1254, in run
13:49:10.520 - [ERROR] (Plugin Instance)   File "TP-SteamFriend.py", line 200, in update
13:49:10.526 - [ERROR] (Plugin Instance)   File "TP-SteamFriend.py", line 68, in getGameAchievements
13:49:10.533 - [ERROR] (Plugin Instance) KeyError: 'achievements'

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.