# Service Overview

Steam LFG Service is a LFG solution written in [Python](https://www.python.org/), based on the [Steam API](https://partner.steamgames.com/doc/webapi). We provide a easy to use and robust customizable Discord Bot, for any server looking to be a hub for Steam Gamers.

This project was created with a desire to help streamline the process for Discord Users attempting to connect via Steam. It makes great usage of the [Steam Browser Protocol](https://developer.valvesoftware.com/wiki/Steam_browser_protocol) allowing to automatically join users to lobbies, and send friend requests to hosts!

See the below documentation to understand all available commands and necessary permissions.

## Steam API

As mentioned prior, the Steam API is crucial to enabling our service. See below an outline of the data which is requested from users and how it is stored then used in order to query the API.

* [ ] **Data requested from Users:**
  * [ ] Steam Friend Code (**Ex:** 165730107)
    * [ ] **Why:** Steam Friend Codes are requested in order to query the Steam API so we can access your Steam Profile and Steam Game History. Dependent on your visibility settings, we use the returned [JSON ](https://en.wikipedia.org/wiki/JSON)data to build a LFG post.
* [ ] **Data Stored about Users:**
  * [ ] **SteamID:** Upon providing a valid Steam Friend Code when running **/register**, we use it to grab your unique [steamID64](https://developer.valvesoftware.com/wiki/SteamID). This ID queries profile information and can be used to generate a web protocol. (**Ex:** [Friend Link](steam://friends/add/76561198125995835))
  * [ ] **DiscordID:** If you provide a valid Steam Friend Code when running **/register**, we will then query your unique [Discord User ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-) in order to associate your Discord with your Steam.&#x20;
* [ ] **How Stored Data is used:**
  * [ ] A variety of offered slash commands such as **/host**, **/link**, **/search**, or **/register** query the Steam API to generate the below information in order to present a LFG Post.
    * [ ] **Profile URL:** The direct link to the dashboard for your Steam profile where users can see your description and add you as a friend. (**Ex:** [Profile URL](https://steamcommunity.com/id/garrusvalkyrin/))
    * [ ] **Persona Name:** The public username of your Steam Profile. (**Ex:** Garrus Valkyrin)
    * [ ] **Profile Avatar:** The picture of your Steam Account will be used to set the right-hand side image of a LFG post. (**Ex:** [Avatar Link](https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/f9/f968f9d0f77f169fc6b05c9e54303cf36508ced7.jpg))
    * [ ] **LobbySteamID:** This is the ID of the Server or Lobby your game is currently being hosted on. Using the [Steam Browser Protocol](https://developer.valvesoftware.com/wiki/Steam_browser_protocol) we then generate a Join Lobby or Connect link which automatically opens your game into said Server or Lobby. (**Ex:** [Join Link](steam://joinlobby/281990/109775240999021651)) (**Ex:** [Connect Link](steam://connect/85.190.157.220:2402))
    * [ ] **Recently Played Games:** We pull data on your most [recently played game](https://partner.steamgames.com/doc/webapi/IPlayerService#GetRecentlyPlayedGames), which we assume to be the game you intend to LFG for. This data is used for visuals in a Post.
      * [ ] **APPID:** The unique ID used in the Steam API to identify this Steam Title from others. (**Ex:** [281990](https://store.steampowered.com/))
      * [ ] **Name:** The name of the Steam Title on the Steam Store (**Ex:** Stellaris)
      * [ ] **IMG Icon URL:** The URL of the logo for the Steam Title displayed in a user's library. (**Ex:** [Stellaris Logo](https://images-ext-2.discordapp.net/external/tM4XRV3jWseQ4EiNi1nWovVRmbyqxelzxeQl53Zj-Cc/http/cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/3e4dfdf4b304b1f4552c279ea716238876ac02c8.jpg))

### Technical Overview

For more advanced eyes only, see below the exact methods used to query the above information:

## Gets information about a player's profile

<mark style="color:blue;">`GET`</mark> `https://api.steampowered.com/ISteamUser/GetPlayerSummaries/v2/`

Upon providing a valid Steam Friend Code, we use it to grab your unique [steamID64](https://developer.valvesoftware.com/wiki/SteamID). This ID queries profile information and can be used to generate a web protocol [Friend Link](steam://friends/add/76561198125995835).

#### Path Parameters

| Name                                     | Type   | Description                                 |
| ---------------------------------------- | ------ | ------------------------------------------- |
| key<mark style="color:red;">\*</mark>    | string | Steamworks Web API user authentication key. |
| string<mark style="color:red;">\*</mark> | string | Comma-delimited list of SteamIDs (max: 100) |

{% tabs %}
{% tab title="200: OK Example response of this query:" %}

```javascript
{
   "response":{
      "players":[
         {
            "steamid":"76561198125995835",
            "communityvisibilitystate":3,
            "profilestate":1,
            "personaname":"Garrus Valkyrin",
            "commentpermission":2,
            "profileurl":"https://steamcommunity.com/id/garrusvalkyrin/",
            "avatar":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/f9/f968f9d0f77f169fc6b05c9e54303cf36508ced7.jpg",
            "avatarmedium":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/f9/f968f9d0f77f169fc6b05c9e54303cf36508ced7_medium.jpg",
            "avatarfull":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/f9/f968f9d0f77f169fc6b05c9e54303cf36508ced7_full.jpg",
            "avatarhash":"f968f9d0f77f169fc6b05c9e54303cf36508ced7",
            "lastlogoff":1637409102,
            "personastate":1,
            "realname":"Garrus",
            "primaryclanid":"103582791440010567",
            "timecreated":1391993403,
            "personastateflags":0,
            "gameextrainfo":"Stellaris",
            "gameid":"281990",
            "lobbysteamid":"109775240999021651",
            "loccountrycode":"UM"
         }
      ]
   }
}
```

{% endtab %}
{% endtabs %}

## Gets information about a player's recently played games

<mark style="color:blue;">`GET`</mark> `https://api.steampowered.com/IPlayerService/GetRecentlyPlayedGames/v1/`

We pull data on your most [recently played game](https://partner.steamgames.com/doc/webapi/IPlayerService#GetRecentlyPlayedGames), which we assume to be the game you intend to LFG for. Using below Parameters we use the Responses to visualize said game.

#### Path Parameters

| Name                                     | Type   | Description                                  |
| ---------------------------------------- | ------ | -------------------------------------------- |
| key<mark style="color:red;">\*</mark>    | string | Steamworks Web API user authentication key.  |
| uint64<mark style="color:red;">\*</mark> | uint64 | The player we're asking about                |
| count<mark style="color:red;">\*</mark>  | uint32 | The number of games to return (0/unset: all) |

{% tabs %}
{% tab title="200: OK Example response of this query:" %}

```javascript
[
   {
      "appid":1466860,
      "name":"Age of Empires IV",
      "playtime_2weeks":1392,
      "playtime_forever":3097,
      "img_icon_url":"503acf3ef0503e24af6b5336012a1f585a2f955e",
      "img_logo_url":"15385a98e770d1a8fd4a1ab19942bc68b3a3b13b",
      "playtime_windows_forever":3097,
      "playtime_mac_forever":0,
      "playtime_linux_forever":0
   },
   {
      "appid":603850,
      "name":"Age of History II",
      "playtime_2weeks":1107,
      "playtime_forever":4951,
      "img_icon_url":"70a6108718bc4fa8aa0155fcfce6e64d8607b93a",
      "img_logo_url":"c4b00bbdad1b92ba89c2128f29ebe8ec1ee64613",
      "playtime_windows_forever":2199,
      "playtime_mac_forever":0,
      "playtime_linux_forever":0
   },
   {
      "appid":281990,
      "name":"Stellaris",
      "playtime_2weeks":864,
      "playtime_forever":48529,
      "img_icon_url":"3e4dfdf4b304b1f4552c279ea716238876ac02c8",
      "img_logo_url":"f5cbaabbd315bd64e2af4c3b8193d59d310786d1",
      "playtime_windows_forever":17446,
      "playtime_mac_forever":0,
      "playtime_linux_forever":0
   },
   {
      "appid":1517290,
      "name":"Battlefield™ 2042",
      "playtime_2weeks":321,
      "playtime_forever":321,
      "img_icon_url":"dc805cd05c36a1b26f4eb57b64301e6708e20776",
      "img_logo_url":"5e528ce1b7ad6ff72ad4cb285c6a55983a0749e2",
      "playtime_windows_forever":321,
      "playtime_mac_forever":0,
      "playtime_linux_forever":0
   },
   {
      "appid":976730,
      "name":"Halo: The Master Chief Collection",
      "playtime_2weeks":80,
      "playtime_forever":1748,
      "img_icon_url":"196a45d8df1981ff6b6b1872a38dc38f6c22875d",
      "img_logo_url":"9c861f652a1b056dd8f60beacae9577ecab59f9f",
      "playtime_windows_forever":1748,
      "playtime_mac_forever":0,
      "playtime_linux_forever":0
   },
   {
      "appid":1240440,
      "name":"Halo Infinite",
      "playtime_2weeks":38,
      "playtime_forever":38,
      "img_icon_url":"ec684b943169d675439f6cdf64fa2f2aa90d9821",
      "img_logo_url":"8af1b72ec4407ec71ff241ec610e87d3df263488",
      "playtime_windows_forever":38,
      "playtime_mac_forever":0,
      "playtime_linux_forever":0
   }
]
```

{% endtab %}
{% endtabs %}

## Gets information about a Steam Store Application

<mark style="color:blue;">`GET`</mark> `http://store.steampowered.com/api/appdetails`

In order to check the game you are currently playing is an official Steam Title, we used this method to verify it is currently listed on the Steam Store.

#### Path Parameters

| Name                                     | Type   | Description                           |
| ---------------------------------------- | ------ | ------------------------------------- |
| appids<mark style="color:red;">\*</mark> | string | The application id we're asking about |

{% tabs %}
{% tab title="200: OK Example response of this query:" %}

```javascript
{
   "281990":{
      "success":true,
      "data":{
         "type":"game",
         "name":"Stellaris",
         "steam_appid":281990,
         "required_age":0,
         "is_free":false,
         "dlc":[
            1749080,
            1522090,
            1341520,
            1140001,
            1140000,
            1045980,
            944290,
            716670,
            553280,
            844810,
            642750,
            518910,
            756010,
            498870,
            492740,
            497660,
            633310,
            616191
         ],
         "detailed_description":"<h1>Just Updated</h1><p><a href=\"https://store.steampowered.com/app/498870/Stellaris_Plantoids_Species_Pack/\" target=\"_blank\" rel=\"noreferrer\"  id=\"dynamiclink_0\" >https://store.steampowered.com/app/498870/Stellaris_Plantoids_Species_Pack/</a></p><br><h1>Featured DLC</h1><p><a href=\"https://store.steampowered.com/app/1522090/Stellaris_Nemesis/\" target=\"_blank\" rel=\"noreferrer\"  id=\"dynamiclink_1\" >https://store.steampowered.com/app/1522090/Stellaris_Nemesis/</a></p><br><h1>Galaxy Edition</h1><p><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/Galaxy_package.png?t=1634659840\" /><br><br><br><strong>Stellaris Galaxy Edition includes:</strong><h2 class=\"bb_tag\">DIGITAL ORIGINAL SOUNDTRACK</h2>The Stellaris soundtrack delivers two and a half hours of original music, including bonus tracks and alternate versions not included in the game. Composed by Andreas Waldetoft with appearances by the Brandenburg State Orchestra and Mia Stegmar, listeners will hear themes meant to evoke discovery and far-reaching exploration through the vast expanse of space through the fusion of orchestral and electronic music. MP3 and lossless FLAC are included.<h2 class=\"bb_tag\">EXCLUSIVE ALIEN RACE (COSMETIC DLC)</h2>Colonize the unknown and build a glorious spider empire! An exclusive alien race will be added to your game with a unique arachnid design. When your friends ask how you obtained these new spacefaring spiders, be sure to tell them you found the deal on the web.<h2 class=\"bb_tag\">DIGITAL COLLECTOR\\'S BOOK </h2>Join the creative team behind Stellaris to learn how the game\\'s aesthetic was designed and realized for Paradox\\'s most visually unique game to date. From concept art all the way through full illustrations and 3D renderings, this exclusive 130-page  book includes a collection of game art unavailable anywhere else -- along with insight into the thoughts and research that drove these designs, the problems the team faced along the way, and the ways they finally brought these visuals to life.<h2 class=\"bb_tag\">STELLARIS INFINITE FRONTIER NOVEL BY STEVEN SAVILE (ebook)</h2>From best-selling author, Steven Savile comes an original novel based on the science-fiction setting of Paradox\\'s Stellaris. When the Commonwealth of Man receives proof that they are not alone in the universe, humanity is divided: should our species seek salvation in potential friends among the stars, or prepare for an inevitable war? What discoveries await the colony ship as they journey into the unknown to find the source of a mysterious alien signal? Download and read on epub, mobi (Kindle) and PDF.<h2 class=\"bb_tag\">EXCLUSIVE AVATAR AND GALAXY FORUM ICON</h2>Show your love for Stellaris on the Paradox Forums and other social networks.<h2 class=\"bb_tag\">SIGNED WALLPAPER</h2>Pay your respects to the pioneers who ventured forth into the unknown with this desktop wallpaper signed by the Stellaris development team.</p><br><h1>About the Game</h1>Get ready to explore, discover and interact with a multitude of species as you journey among the stars. Forge a galactic empire by sending out science ships to survey and explore, while construction ships build stations around newly discovered planets. Discover buried treasures and galactic wonders as you spin a direction for your society, creating limitations and evolutions for your explorers. Alliances will form and wars will be declared.<br> <br>Like all our Grand Strategy games, the adventure evolves with time. Because free updates are a part of any active Paradox game, you can continue to grow and expand your empire with new technologies and capabilities. What will you find beyond the stars? Only you can answer that.<br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/Deep_and_Varied_Exploration_1.gif?t=1634659840\" /><h2 class=\"bb_tag\">DEEP AND VARIED EXPLORATION</h2>Every game begins with a civilization that has just discovered the means to travel between stars and is ready to explore the galaxy. Have your science ships survey and explore anomalies, leading you into a myriad of quests, introducing strange worlds with even stranger stories and discoveries that may completely change your outcome.<br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/STUNNING_SPACE_VISUALS_1.gif?t=1634659840\" /><h2 class=\"bb_tag\">STUNNING SPACE VISUALS</h2>With characteristically complex unique planets and celestial bodies, you will enter a whirlwind of spectacles in a highly detailed universe.<br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/Species_and_Diplomacy_1.gif?t=1634659840\" /><h2 class=\"bb_tag\">INFINITE VARIATION OF SPECIES AND ADVANCED DIPLOMACY</h2>Through customization and procedural generation, you will encounter infinitely varied races. Choose positive or negative traits, specific ideologies, limitations, evolutions or anything you can imagine. Interact with others through the advanced diplomacy system. Diplomacy is key in a proper grand strategy adventure. Adjust your strategy to your situation through negotiation and skill. <br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/Interstellar_Warfare_1.gif?t=1634659840\" /><h2 class=\"bb_tag\">INTERSTELLAR WARFARE</h2>An eternal cycle of war, diplomacy, suspicions and alliances await you. Defend or attack with fully customizable war fleets, where adaptation is the key to victory. Choose from an array of complex technologies when designing and customizing your ships with the complex ship designer. You have a multitude of capabilities to choose from to meet the unknown quests that await.<br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/ENORMOUS_PROCEDURAL_GALAXIES.gif?t=1634659840\" /><h2 class=\"bb_tag\">ENORMOUS PROCEDURAL GALAXIES</h2>Grow and expand your empire with thousands of randomly generated planet types, galaxies, quests and monsters lurking in space.<br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/PLAY_THE_WAY_YOU_WANT.gif?t=1634659840\" /><h2 class=\"bb_tag\">PLAY THE WAY YOU WANT</h2>Customize your Empire! The characters you choose, be it a murderous mushroom society or an engineering reptile race, can be customized with traits like ethics, type of technology, form of preferred space travel, type of habitat, philosophies and more. The direction of the game is based on your choices.<h2 class=\"bb_tag\">FREE UPDATE HISTORY</h2><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/roadmap_20210914-2.png?t=1634659840\" />",
         "about_the_game":"Get ready to explore, discover and interact with a multitude of species as you journey among the stars. Forge a galactic empire by sending out science ships to survey and explore, while construction ships build stations around newly discovered planets. Discover buried treasures and galactic wonders as you spin a direction for your society, creating limitations and evolutions for your explorers. Alliances will form and wars will be declared.<br> <br>Like all our Grand Strategy games, the adventure evolves with time. Because free updates are a part of any active Paradox game, you can continue to grow and expand your empire with new technologies and capabilities. What will you find beyond the stars? Only you can answer that.<br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/Deep_and_Varied_Exploration_1.gif?t=1634659840\" /><h2 class=\"bb_tag\">DEEP AND VARIED EXPLORATION</h2>Every game begins with a civilization that has just discovered the means to travel between stars and is ready to explore the galaxy. Have your science ships survey and explore anomalies, leading you into a myriad of quests, introducing strange worlds with even stranger stories and discoveries that may completely change your outcome.<br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/STUNNING_SPACE_VISUALS_1.gif?t=1634659840\" /><h2 class=\"bb_tag\">STUNNING SPACE VISUALS</h2>With characteristically complex unique planets and celestial bodies, you will enter a whirlwind of spectacles in a highly detailed universe.<br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/Species_and_Diplomacy_1.gif?t=1634659840\" /><h2 class=\"bb_tag\">INFINITE VARIATION OF SPECIES AND ADVANCED DIPLOMACY</h2>Through customization and procedural generation, you will encounter infinitely varied races. Choose positive or negative traits, specific ideologies, limitations, evolutions or anything you can imagine. Interact with others through the advanced diplomacy system. Diplomacy is key in a proper grand strategy adventure. Adjust your strategy to your situation through negotiation and skill. <br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/Interstellar_Warfare_1.gif?t=1634659840\" /><h2 class=\"bb_tag\">INTERSTELLAR WARFARE</h2>An eternal cycle of war, diplomacy, suspicions and alliances await you. Defend or attack with fully customizable war fleets, where adaptation is the key to victory. Choose from an array of complex technologies when designing and customizing your ships with the complex ship designer. You have a multitude of capabilities to choose from to meet the unknown quests that await.<br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/ENORMOUS_PROCEDURAL_GALAXIES.gif?t=1634659840\" /><h2 class=\"bb_tag\">ENORMOUS PROCEDURAL GALAXIES</h2>Grow and expand your empire with thousands of randomly generated planet types, galaxies, quests and monsters lurking in space.<br><br><br><br><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/PLAY_THE_WAY_YOU_WANT.gif?t=1634659840\" /><h2 class=\"bb_tag\">PLAY THE WAY YOU WANT</h2>Customize your Empire! The characters you choose, be it a murderous mushroom society or an engineering reptile race, can be customized with traits like ethics, type of technology, form of preferred space travel, type of habitat, philosophies and more. The direction of the game is based on your choices.<h2 class=\"bb_tag\">FREE UPDATE HISTORY</h2><img src=\"https://cdn.cloudflare.steamstatic.com/steam/apps/281990/extras/roadmap_20210914-2.png?t=1634659840\" />",
         "short_description":"Explore a galaxy full of wonders in this sci-fi grand strategy game from Paradox Development Studios. Interact with diverse alien races, discover strange new worlds with unexpected events and expand the reach of your empire. Each new adventure holds almost limitless possibilities.",
         "supported_languages":"English, French, German, Spanish - Spain, Polish, Portuguese - Brazil, Russian, Simplified Chinese",
         "reviews":"“Calling Stellaris Europa Universalis in space is probably reductive, but it was the first thing I did in this review not because they are almost exactly alike, but because, when I put away my empires and get on with my day, the stories that have played out in these digital worlds embed themselves in my brain, and I so desperately want to tell people about them. Both games tickle the part of my brain that wants every battle to have some greater context, every move I make to be part of a larger narrative. Stellaris manages to do this without history to lean on, though, and does so with aplomb.”<br>9/10 – <a href=\"https://steamcommunity.com/linkfilter/?url=http://www.pcgamesn.com/stellaris-review\" target=\"_blank\" rel=\"noopener\"  >PCGamesN</a><br><br>“An excellent science fiction space strategy game”<br><a href=\"https://steamcommunity.com/linkfilter/?url=https://www.nytimes.com/2020/04/01/arts/gaming-introduction-basics-quarantine-coronavirus.html\" target=\"_blank\" rel=\"noopener\"  >The New York Times</a><br><br>“Stellaris is one of the best space 4X strategy games around, allowing you to create your very own civilization, venture out into the unknown and meet new species as you explore the stars.”<br><a href=\"https://steamcommunity.com/linkfilter/?url=https://www.windowscentral.com/these-pc-games-sale-will-make-staying-home-whole-lot-more-fun\" target=\"_blank\" rel=\"noopener\"  >Windows Central</a><br>",
         "header_image":"https://cdn.akamai.steamstatic.com/steam/apps/281990/header.jpg?t=1634659840",
         "website":"https://www.stellaris.com/",
         "pc_requirements":{
            "minimum":"<strong>Minimum:</strong><br><ul class=\"bb_ul\"><li><strong>OS:</strong> Windows® 7 SP1 64 Bit<br></li><li><strong>Processor:</strong> Intel® iCore™ i3-530 or AMD® FX-6350<br></li><li><strong>Memory:</strong> 4 GB RAM<br></li><li><strong>Graphics:</strong> Nvidia® GeForce™ GTX 460 or AMD® ATI Radeon™ HD 5870  (1GB VRAM), or AMD® Radeon™  RX Vega 11 or Intel® HD Graphics 4600<br></li><li><strong>DirectX:</strong> Version 9.0c<br></li><li><strong>Network:</strong> Broadband Internet connection<br></li><li><strong>Storage:</strong> 10 GB available space<br></li><li><strong>Sound Card:</strong> Direct X 9.0c- compatible sound card<br></li><li><strong>Additional Notes:</strong> Controller support: 3-button mouse, keyboard and speakers. Special multiplayer requirements: Internet Connection</li></ul>",
            "recommended":"<strong>Recommended:</strong><br><ul class=\"bb_ul\"><li><strong>OS:</strong> Windows® 10 Home 64 Bit<br></li><li><strong>Processor:</strong> Intel® iCore™ i5-3570K or AMD® Ryzen™ 5 2400G<br></li><li><strong>Memory:</strong> 4 GB RAM<br></li><li><strong>Graphics:</strong> Nvidia® GeForce™ GTX 560 Ti  (1GB VRAM) or AMD® Radeon™ R7 370 (2 GB VRAM)<br></li><li><strong>DirectX:</strong> Version 12<br></li><li><strong>Network:</strong> Broadband Internet connection<br></li><li><strong>Storage:</strong> 10 GB available space<br></li><li><strong>Sound Card:</strong> DirectX 9.0c-compatible sound card<br></li><li><strong>Additional Notes:</strong> Controller support: 3-button mouse, keyboard and speakers. Special multiplayer requirements: Internet Connection</li></ul>"
         },
         "mac_requirements":{
            "minimum":"<strong>Minimum:</strong><br><ul class=\"bb_ul\"><li><strong>OS:</strong> 10.11 (El Capitan)<br></li><li><strong>Processor:</strong> Intel® iCore™ i5-4570S<br></li><li><strong>Memory:</strong> 8 GB RAM<br></li><li><strong>Graphics:</strong> Nvidia® GeForce™ GT 750M or equivalent AMD®  card with 1GB Vram<br></li><li><strong>Network:</strong> Broadband Internet connection<br></li><li><strong>Storage:</strong> 10 GB available space<br></li><li><strong>Additional Notes:</strong> Controller support: 3-button mouse, keyboard and speakers. Special multiplayer requirements: Internet Connection</li></ul>",
            "recommended":"<strong>Recommended:</strong><br><ul class=\"bb_ul\"><li><strong>OS:</strong> 10.13 (High Sierra)<br></li><li><strong>Processor:</strong> Intel® iCore™ i5-4670<br></li><li><strong>Memory:</strong> 8 GB RAM<br></li><li><strong>Graphics:</strong> Nvidia® GeForce™ GTX 780M with 4GB Vram or AMD® Radeon™ R7 370 (2 GB VRAM)<br></li><li><strong>Network:</strong> Broadband Internet connection<br></li><li><strong>Storage:</strong> 10 GB available space<br></li><li><strong>Additional Notes:</strong> Controller support: 3-button mouse, keyboard and speakers. Special multiplayer requirements: Internet Connection</li></ul>"
         },
         "linux_requirements":{
            "minimum":"<strong>Minimum:</strong><br><ul class=\"bb_ul\"><li><strong>OS:</strong> Ubuntu 16.04 x64<br></li><li><strong>Processor:</strong> Intel® iCore™ i3-530 or AMD® FX-6350<br></li><li><strong>Memory:</strong> 4 GB RAM<br></li><li><strong>Graphics:</strong> Nvidia® GeForce™ GTX 460 or AMD® ATI Radeon™ HD 5870  (1GB VRAM), or AMD® Radeon™  RX Vega 11 or Intel® HD Graphics 4600<br></li><li><strong>Network:</strong> Broadband Internet connection<br></li><li><strong>Storage:</strong> 12 GB available space<br></li><li><strong>Sound Card:</strong> Direct X 9.0c- compatible sound card<br></li><li><strong>Additional Notes:</strong> Controller support: 3-button mouse, keyboard and speakers. Special multiplayer requirements: Internet Connection</li></ul>",
            "recommended":"<strong>Recommended:</strong><br><ul class=\"bb_ul\"><li><strong>OS:</strong> Ubuntu 16.04 x64<br></li><li><strong>Processor:</strong> Intel® iCore™ i5-3570K or AMD® Ryzen™ 5 2400G<br></li><li><strong>Memory:</strong> 4 GB RAM<br></li><li><strong>Graphics:</strong> Nvidia® GeForce™ GTX 560 Ti  (1GB VRAM) or AMD® Radeon™ R7 370 (2 GB VRAM)<br></li><li><strong>Network:</strong> Broadband Internet connection<br></li><li><strong>Storage:</strong> 12 GB available space<br></li><li><strong>Sound Card:</strong> Direct X 9.0c- compatible sound card<br></li><li><strong>Additional Notes:</strong> Controller support: 3-button mouse, keyboard and speakers. Special multiplayer requirements: Internet Connection</li></ul>"
         },
         "legal_notice":"©2016-2021 and published by Paradox Interactive AB. STELLARIS and PARADOX INTERACTIVE are trademarks and/or registered trademarks of Paradox Interactive AB in Europe, the U.S., and other countries. Other trademarks, logos, and copyrights are the property of their respective owners.",
         "developers":[
            "Paradox Development Studio"
         ],
         "publishers":[
            "Paradox Interactive"
         ],
         "price_overview":{
            "currency":"USD",
            "initial":3999,
            "final":3999,
            "discount_percent":0,
            "initial_formatted":"",
            "final_formatted":"$39.99"
         },
         "packages":[
            38760,
            100387
         ],
         "package_groups":[
            {
               "name":"default",
               "title":"Buy Stellaris",
               "description":"",
               "selection_text":"Select a purchase option",
               "save_text":"",
               "display_type":0,
               "is_recurring_subscription":"false",
               "subs":[
                  {
                     "packageid":38760,
                     "percent_savings_text":" ",
                     "percent_savings":0,
                     "option_text":"Stellaris - $39.99",
                     "option_description":"",
                     "can_get_free_license":"0",
                     "is_free_license":false,
                     "price_in_cents_with_discount":3999
                  },
                  {
                     "packageid":100387,
                     "percent_savings_text":" ",
                     "percent_savings":0,
                     "option_text":"Stellaris - Galaxy Edition - $49.99",
                     "option_description":"",
                     "can_get_free_license":"0",
                     "is_free_license":false,
                     "price_in_cents_with_discount":4999
                  }
               ]
            }
         ],
         "platforms":{
            "windows":true,
            "mac":true,
            "linux":true
         },
         "metacritic":{
            "score":78,
            "url":"https://www.metacritic.com/game/pc/stellaris?ftag=MCD-06-10aaa1f"
         },
         "categories":[
            {
               "id":2,
               "description":"Single-player"
            },
            {
               "id":1,
               "description":"Multi-player"
            },
            {
               "id":27,
               "description":"Cross-Platform Multiplayer"
            },
            {
               "id":22,
               "description":"Steam Achievements"
            },
            {
               "id":29,
               "description":"Steam Trading Cards"
            },
            {
               "id":30,
               "description":"Steam Workshop"
            },
            {
               "id":23,
               "description":"Steam Cloud"
            }
         ],
         "genres":[
            {
               "id":"28",
               "description":"Simulation"
            },
            {
               "id":"2",
               "description":"Strategy"
            }
         ],
         "screenshots":[
            {
               "id":0,
               "path_thumbnail":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_f844372cc220e3858aa17205e9fec0ae79a4e665.600x338.jpg?t=1634659840",
               "path_full":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_f844372cc220e3858aa17205e9fec0ae79a4e665.1920x1080.jpg?t=1634659840"
            },
            {
               "id":1,
               "path_thumbnail":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_692532123e560e6b866baee59b1e310a291a110d.600x338.jpg?t=1634659840",
               "path_full":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_692532123e560e6b866baee59b1e310a291a110d.1920x1080.jpg?t=1634659840"
            },
            {
               "id":2,
               "path_thumbnail":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_7f4d7cc160c43e77aa523e910b365e0ca436e6bb.600x338.jpg?t=1634659840",
               "path_full":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_7f4d7cc160c43e77aa523e910b365e0ca436e6bb.1920x1080.jpg?t=1634659840"
            },
            {
               "id":3,
               "path_thumbnail":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_034b0d55a5c370bec4709f09d0914f9d131b7788.600x338.jpg?t=1634659840",
               "path_full":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_034b0d55a5c370bec4709f09d0914f9d131b7788.1920x1080.jpg?t=1634659840"
            },
            {
               "id":4,
               "path_thumbnail":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_ee82888c27afb4174cf4cae6298b54c7c1e2a682.600x338.jpg?t=1634659840",
               "path_full":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_ee82888c27afb4174cf4cae6298b54c7c1e2a682.1920x1080.jpg?t=1634659840"
            },
            {
               "id":5,
               "path_thumbnail":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_fc94710913be85306f2fe5258d0f0d8d1c87e945.600x338.jpg?t=1634659840",
               "path_full":"https://cdn.akamai.steamstatic.com/steam/apps/281990/ss_fc94710913be85306f2fe5258d0f0d8d1c87e945.1920x1080.jpg?t=1634659840"
            }
         ],
         "movies":[
            {
               "id":256725083,
               "name":"New Base Game Trailer",
               "thumbnail":"https://cdn.akamai.steamstatic.com/steam/apps/256725083/movie.293x165.jpg?t=1589230189",
               "webm":{
                  "480":"http://cdn.akamai.steamstatic.com/steam/apps/256725083/movie480.webm?t=1589230189",
                  "max":"http://cdn.akamai.steamstatic.com/steam/apps/256725083/movie_max.webm?t=1589230189"
               },
               "mp4":{
                  "480":"http://cdn.akamai.steamstatic.com/steam/apps/256725083/movie480.mp4?t=1589230189",
                  "max":"http://cdn.akamai.steamstatic.com/steam/apps/256725083/movie_max.mp4?t=1589230189"
               },
               "highlight":true
            },
            {
               "id":256784480,
               "name":"Stellaris 4th Anniversary Trailer",
               "thumbnail":"https://cdn.akamai.steamstatic.com/steam/apps/256784480/movie.293x165.jpg?t=1589271454",
               "webm":{
                  "480":"http://cdn.akamai.steamstatic.com/steam/apps/256784480/movie480_vp9.webm?t=1589271454",
                  "max":"http://cdn.akamai.steamstatic.com/steam/apps/256784480/movie_max_vp9.webm?t=1589271454"
               },
               "mp4":{
                  "480":"http://cdn.akamai.steamstatic.com/steam/apps/256784480/movie480.mp4?t=1589271454",
                  "max":"http://cdn.akamai.steamstatic.com/steam/apps/256784480/movie_max.mp4?t=1589271454"
               },
               "highlight":true
            }
         ],
         "recommendations":{
            "total":82420
         },
         "achievements":{
            "total":124,
            "highlighted":[
               {
                  "name":"Brave New World",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/84e8189873b3ecfe8ecdc51edab7257b617f8518.jpg"
               },
               {
                  "name":"Digging Deep",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/819ecf3a3a35ca75374d3322e309da7fa0d5c001.jpg"
               },
               {
                  "name":"The Industrial Re-Revolution",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/a44aceaeb6f969bd49acc31c7d3a54f8f3af5267.jpg"
               },
               {
                  "name":"Energetic",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/a23d81d64a878d2dad54b20052abcd5461811bc3.jpg"
               },
               {
                  "name":"Power Overwhelming",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/6499ad0b7498f5edffc2bafcc230823a2963663b.jpg"
               },
               {
                  "name":"Birth of a Federation",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/d876f294e440912559d181dc51d1c43be50ff21c.jpg"
               },
               {
                  "name":"New Shining Star",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/4cf81abd6987194436eb58ee811a0b12c8961143.jpg"
               },
               {
                  "name":"Battle Thralls",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/2f7e0091099134e524f1091bfe85f094a8a2a227.jpg"
               },
               {
                  "name":"Explorer",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/c6aa403fdd3ae514fb760647455b629c06314fa0.jpg"
               },
               {
                  "name":"Grand Admiral",
                  "path":"https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/281990/5bda557ee61bca333db9319293702a449b1580e4.jpg"
               }
            ]
         },
         "release_date":{
            "coming_soon":false,
            "date":"May 9, 2016"
         },
         "support_info":{
            "url":"https://paradox.zendesk.com/home",
            "email":"support@paradoxplaza.com"
         },
         "background":"https://cdn.akamai.steamstatic.com/steam/apps/281990/page_bg_generated_v6b.jpg?t=1634659840",
         "content_descriptors":{
            "ids":[
               
            ],
            "notes":"None"
         }
      }
   }
}
```

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
**Note:** in order to query the above information we require users to maintain a Public Profile. See [/register](/overview/slash-commands/setup/thread-creation.md) on how to setup the appropriate visibility settings in order to avoid errors.
{% endhint %}

### Slash Commands

Follow our handy guides to get started on the basics as quickly as possible:

{% content-ref url="/pages/ZTz2udGD1POeVPGn9DZc" %}
[/setup](/overview/slash-commands/setup.md)
{% endcontent-ref %}

{% content-ref url="/pages/0K5uIYOf6zl8gIZXXomJ" %}
[/register](/overview/slash-commands/register.md)
{% endcontent-ref %}

{% content-ref url="/pages/B6QaKJALabCLJtjIMTXc" %}
[/host](/overview/slash-commands/host.md)
{% endcontent-ref %}

{% content-ref url="/pages/ZmYrkTVgybUFyH70QhO4" %}
[/modify](/overview/slash-commands/modify.md)
{% endcontent-ref %}

{% content-ref url="/pages/WISmaQCt9rXJB6tVy2jj" %}
[/announce](/overview/slash-commands/announce.md)
{% endcontent-ref %}

{% content-ref url="/pages/p3osNSFEGOilGyTqMLcE" %}
[/link](/overview/slash-commands/link.md)
{% endcontent-ref %}

{% content-ref url="/pages/SGv1uhxD9oA0Tlikcdb1" %}
[/karma](/overview/slash-commands/karma.md)
{% endcontent-ref %}

{% content-ref url="/pages/7zYxkBhXLsqTkXnCmFLR" %}
[/search](/overview/slash-commands/search.md)
{% endcontent-ref %}

{% content-ref url="/pages/uY4d0eAm6TVeEuynqlxs" %}
[/notify](/overview/slash-commands/notify.md)
{% endcontent-ref %}

{% hint style="info" %}
**Tip:** looking to suggest a feature or to report a bug? Join our [Support Discord](https://discord.gg/8DE5z5tTY8) anytime!
{% endhint %}

### Permissions

Learn what is required in order to power our expansive slash commands:

{% content-ref url="/pages/5iL74pXmQX9bjvCDLnGD" %}
[Permissions](/overview/permissions.md)
{% endcontent-ref %}

{% hint style="warning" %}
**Important:** all above permissions are **required** in order to fully operate our service on join!
{% endhint %}

### Important Links

If interested in inviting our the Steam LFG Service to your server, or in contacting us, see below:

{% embed url="<https://discord.gg/8DE5z5tTY8>" %}
Our Support Discord server where you can report any bugs or provide suggestions for new features!
{% endembed %}

{% embed url="<https://discord.com/oauth2/authorize?client_id=284839059157942274&permissions=534723914817&scope=bot+applications.commands>" %}
Our official invitation link for server admins, allowing you to see our requested permissions and thus use this service!
{% endembed %}

{% embed url="<https://valkyrinllc.gitbook.io/steamlfgservice/links/privacy-policy>" %}
A legal overview regarding the data we collect, how we store it, and how we use it.
{% endembed %}

{% embed url="<https://valkyrinllc.gitbook.io/steamlfgservice/links/contact-us>" %}
Our contact information in the event you have questions, bugs, or would like to provide suggestions directly!
{% endembed %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://steamlfg.gitbook.io/overview/service-overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
