Search Unity

  1. Engage, network and learn at Unite Austin 2017, Oct 3 - 5. Get your ticket today!
    Dismiss Notice
  2. Introducing the Unity Essentials Packs! Find out more.
    Dismiss Notice
  3. Check out all the fixes for 5.6 on the patch releases page.
    Dismiss Notice
  4. Unity 2017.1 is now released.
    Dismiss Notice
  5. Help us improve the editor usability and artist workflows. Join our discussion to provide your feedback.
    Dismiss Notice
  6. Unity 2017.2 beta is now available for download.
    Dismiss Notice

Steam Leaderboards - Easy Steamworks Integration

Discussion in 'Assets and Asset Store' started by FreebordMAD, Jun 23, 2017.

  1. FreebordMAD

    FreebordMAD

    Joined:
    Mar 15, 2013
    Posts:
    358
    Steam Leaderboards - Easy Steamworks Integration get it from the Unity Asset Store

    As some of you know the Steamworks API is a complex thing. Hence, I want to create a super easy Steam integration that can be used by designers who will only need to drag n' drop a prefab into the scene. I want to minimize the coding part as much as possible.

    I'm still searching for Steam features that you developers need to work in an easy way. Therefore, feel free to say what you need for your projects!

    Description

    The Easy Steamworks Integration brings various Steam features to your game with a very few clicks. The Steam Leaderboards plugin allows to load, sort and filter Steam Leaderboards; scores can be enriched with additional data (like replays/screenshots). You can integrate this plugin within your uGUI menus or trigger a popup leaderboard with a single line of code. The UI is highly customizable and can be adapted to the look of your game.

    Features:
    • single prefab drag n' drop for static UI
    • single code line for popup UI
    • highly customizable uGUI prefabs
    • display leaderboards
    • filter leaderboard entries (range, around user, friends)
    • load Steam avatar textures
    • submit scores
    • format scores (numeric, seconds, milliseconds)
    • add additional data (replays, screenshots)
    • create leaderboards (rank order, display type, update type)
    Screenshots
    [​IMG]
    [​IMG]
    [​IMG]
    [​IMG]

    Game using the Steam Workshop - Easy Steamworks Integration

    - Guts and Glory

    Documentation
    Getting Started
    Link App
    Show Independent Popups
    Add To Existing uGUI
    Scripting Reference

    Getting Started
    After importing the Unity package the leaderboards examples (in ExampleScenesPopup or ExampleScenesStatic folders) will work out of the box - Steam must be running.
    By default Steamworks.NET will use the Steam AppId 480 - SpaceWar, use it for your leaderboards integration tests.
    Please follow the instructions in Link App to view and submit highscores to the leaderboards of your game.

    Link App
    Follow the steps below to set the AppId.
    • Start one of the test scenes to generate the steam_appid.txt file in the root of your project (the folder where Assets, Library and ProjectSettings directories a located).
    • Open the steam_appid.txt file and replace 480 with your Steam AppId.
    • Restart Unity Editor to load your new AppId.
    • Now you should be able to view and submit highscores to the leaderboards of your game by using the provided example scenes (in the ExampleScenesPopup or ExampleScenesStatic folders).
    Show Independent Popups
    The single code line below will show a leaderboard popup for the table named 'Test'. Please find detailed example code in addition with some other useful hints in the SteamLeaderboardsExamplePopup and SteamLeaderboardsExampleAdvancedSettings classes.
    Code (CSharp):
    1. // show the Steam Leaderboard popup for the table 'Test'
    2. ((SteamLeaderboardsPopup)uMyGUI_PopupManager.Instance.ShowPopup("steam_leaderboard")).LeaderboardUI.DownloadScores("Test");
    The single code line below will upload the score value 123 to the table named 'Test'. If the user has improved his recod, then a popup showing his current score, global rank and rank change will be shown. Please find detailed example code in addition with some other useful hints in the SteamLeaderboardsExamplePopup and SteamLeaderboardsExampleAdvancedSettings classes.
    Code (CSharp):
    1. // upload score to Steam Leaderboards
    2. SteamLeaderboardsUI.UploadScore("Test", 123);
    Add To Existing uGUI
    You will find the SteamLeaderboard prefab included in the package. All you need to do is simply drag n' drop it into your Canvas or add it to any of your UI elements.

    Powered by Steamworks.NET
    Steamworks.NET created by Riley Labrecquea. If you are lucky enough to earn some money with your game, then please consider a donation to Riley Labrecquea here.

    Unity Asset Store: https://www.assetstore.unity3d.com/en/#!/content/93354
     
    Last edited: Jul 18, 2017
  2. FreebordMAD

    FreebordMAD

    Joined:
    Mar 15, 2013
    Posts:
    358
    Steam Leaderboards, the second Unity plugin of the Easy Steamworks Integration series, is now available on the Unity Asset Store! Steam Leaderboards can be incorporated into an existing game by writing a single line of code or drag & dropping a prefab. Besides, it is super easy to customize the UI if required. Check it out on the Unity Asset Store.

    Next on the roadmap is Steam Inventory. If you need something Steam related, then please don't hesitate to contact me! I'm trying to launch the one and only easy to use Steam API and I cannot do this without customer feedback and requests!