dunguyen / whatshouldweplay-discord

Discord bot that can display the mutually owned games of a bunch of steam users

What Should We Play

Ever tried to get your friends to play a game but there's always someone who doesn't have it? Or tired of just playing CS:GO for the 8th night in the row? What Should We Play can provide you inspiration for your next multiplayer session.

The bot is easy to use. Simply type wswp play followed by steam ids and it will return a list of common owned multi-player games on the steam accounts.

Get it here: Invite Link or on top.gg

Usage

All commands must be prefixed with wswp unless DM'ing the bot.

Command name	Arguments	Notes
help	Optional: a command name
play	@mentions or steam ids separated by space	If no arguments are provided, the bot will look at the people online and try to use their linked accounts
link	A steam id	This will link your Discord account with the steam id allowing you to use @mention in the play command
unlink	A linked gamertag found through the showlinked command	This will delete the link between a previously linked command and your Discord account
showlinked		Shows all linked gamertags with your Discord account
updatedlinked		Will update linked gamertags of your Discord account. This is not necessary to run as it will be done automatically from time to time but may be useful if you just bought games
delete		Will delete all linked gamertags of your Discord account.
prune		Will delete a number of previous messages written by the bot. Useful for cleaning up a channel. Can only be run by an admin

Privacy

Using the bot's link functionality will save the steam id and associated games and playing times. This information can be deleted through the wswp delete command. Using the bot will save the discord id of the caller and the channel for analytics purposes. By using the bot you agree this information will be saved.

whatshouldweplay-discord's Issues

Sort Options only work in direct messages for a single player, not on server with multiple @s

Sort working in direct message:

Lifebound Today at 2:46 PM
play Playtime
---------------
What Should We Play Bot BOT Today at 2:46 PM
Checking all online members...
Found games for 1 user:
@Lifebound
10 Multi-player games you have in common:
Number of players who own    Game name
1    Elite Dangerous
1    EVE Online
1    Factorio
1    Sid Meier's Civilization® V
1    FINAL FANTASY XIV Online
1    Borderlands 2
1    Grand Theft Auto V
1    Dreadnought
1    Starbound
1    War Thunder

Those results generally track with my Steam library.

Sort not working in a server. Multiple users with linked ID's @'ed

Lifebound Today at 3:00 PM
wswp play @Lifebound @testaccountpleaseignore Playtime
------------------
What Should We Play Bot BOT Today at 3:00 PM
Found games for 2 users:
@Lifebound, @testaccountpleaseignore 
10 Multi-player games you have in common:
Number of players who own    Game name
2    Counter-Strike
2    Counter-Strike: Source
2    Day of Defeat: Source
2    Left 4 Dead 2
2    Portal 2
2    Counter-Strike: Global Offensive
2    Killing Floor
2    Sid Meier's Civilization® IV
2    Sid Meier's Civilization® III Complete
2    Garry's Mod

Factorio should be our commonly shared top title by playtime (a combined 800 hours), followed by Vermintide II (they have 300, I have 35), followed by Crusader Kings 3 (I have 100, he has 30), and only then follyed by anything listed here.

Other sort options are similarly not functional when sorting with multiple people.

Improve output

Right now it's huge list, perhaps provide only 10 random games that everyone owns?

Add option to use mention in play command

Provide guide to find user id in steam

Update database with new titles

Should not be case insensitive

In a DM, prefix is not necessary

Add Tests

Add max multiplayer numbers

Create upper bounds for play command

Perhaps limit to 16 game collections or so. Any more and it is not only costly but there's fewer games that people can actually play

Delete command to delete all personal data from the service

Threshold should be dynamic so that games are always suggested

Add gog support

Add prune command to allow bot to delete own messages

wswp prune - will prune all messages written by the bot within last x days
wswp prune all - will prune all messages written by the bot and by users who have written commands
wswp prune smart - will prune messages by the bot and users relating to help, link, unlinked and showlinked commands

Add show linked tags

User needs to see what gamertags are linked

The play find all players online should not show bots

Bot should not reply to @everyone messages

Play command takes a genre

Provide a command that shows games that not everyone has. Explore?

Could be games that not everyone owns or less frequently played games

Potential bug: a linked user duplicate games will be counted more than once

Add linking between discord users and steam username

Play command sorts after steam review and metacritic review aggregate

Add origin support

User should be able to alter the number of games suggested.

Current number is 10, and the user cannot change this. We suggest passing an optional variable.

Pagination of play command?

Check if it is feasible, and how to represent pagination in the UI/conversationally

Play command can sort after median player time spent

Add epic support

Deployment on Azure

Travis CI should deploy on Azure on successful build

Allow DMs to bot

Bot should listen to DMs for help, link, showlinked, unlink commands. Perhaps some of these commands should be DM only...

Add unlink option to remove gamertag from discord user

Games list on Steam needs to be Public before any games are displayed

Basically the title, and this is hard to set for some people.

Update linked users' libraries

Sort gameslist with common games first

The bot outputs a randomized list of games.
The expected behavior is that games with a count of 1 should not be displayed.

In play.ts (33) you specify the default sort = SortOptions.Random
so it's always Random if you do not say anything else.

In userlibrary.ts (198) you have a switchcase with the default option which it will never hit due to the above.

you could set a condition for line 217 to be numberOwned > 1 or something similar.

Default command should be the play command

wswp @mention @mention
is the same as
wswp play @mention @mention

Optional sort should sort after release date (descending)

Play command can take a role or voice channel reference

Is voice channel references possible?

Add help enumerator over each command

Provide error message if user uses nonexistent steam id

Add sorting options to play command

Sort after popularity: steam rating/number of reviews
Sort after metacritic
Sort after number of active players
Sort after median hours played

Provide messaging if users uses a @mention but the mentioned user hasn't linked any steam accounts

Add analytics

Major questions to answer:
What is the usage? Overall - per command
User retention?

Set up CI/CD

Documentation should include a concrete example

Provide more messaging on play command

Explain what the number is. Explain that it's random multi-player games.

Play command can default to online players

wswp play
Takes all online players and runs play on the users who have linked accounts

Add blizzard support

Remove spam on play command

When using wswp play without arguments, don't reply with mentions for those who are not users.

Refactor play command + add tests