brianchuchua / asoiaf-tmg-discord-bot Goto Github PK

A Discord bot for A Song of Ice and Fire: The Miniatures Game

JavaScript 0.57% TypeScript 99.42% Procfile 0.01%

asoiaf-tmg-discord-bot's Introduction

ASOIAF TMG Discord Bot 🐉

Description

This is a Discord bot that will display images for most cards in the game A Song of Ice and Fire: The Tabletop Miniatures Game.

Updating the Bot

Unfortunately I'm no longer playing ASOIAF TMG, but I'm still happy to help the community keep it up to date.

If you'd like to add new cards, please follow these steps:

Fork this repository
Make your changes to your fork -- it's just editing data in src\asoiaf
Create a pull request to merge your changes into this repository's master branch
Attach a link to a zip file with your updated images -- I'll upload these to the S3 server that hosts the other images
I'll review and merge your changes pretty quickly, within a day or two at most
Once I merge your changes to master, the bot will automatically update itself and restart within a few minutes

Installation

Follow this link to add the bot to your server:

https://discord.com/api/oauth2/authorize?client_id=1011134218786574416&permissions=3072&scope=bot

Usage

First, add the bot to your server uses the step(s) above.

Then, just type the following command in any public chat:

!asoiaf [card name]

Example: !asoiaf Lyanna Mormont

You can also use !a as a shorthand.

Example: !a Lyanna Mormont

You can also search by card type: !asoiaf [search parameter] t:[card type]

Available card types:

t:commander (shorthand: t:cm, t:c)
t:combatunit (shorthand: t:cu)
t:attachment (shorthand: t:a)
t:noncombatunit (shorthand: t:ncu, t:nc, t:n)
t:opponentattachment (shorthand: t:oa, t:o)
t:tacticscard (shorthand: t:tactics, t:tactic, t:tc, t:t)
t:tacticszone (shorthand: t:tz)
t:informationcard (shorthand: t:info, t:i)
t:gamemode (shorthand: t:gm)
t:mission (shorthand: t:m)
t:objective (shorthand: t:ob)
t:terrain (shorthand: t:tr)

Example: !a Eddard t:a for all attachments that include "Eddard" in their name

You can also just ask for the front or back of a card:

!a [search parameter] -front or !a [search parameter] -f

!a [search parameter] -back or !a [search parameter] -b

You can also request every tactics card along with the commander.

!a [search parameter] -all !a jaime -all will bring up Jaime's commander card and all of his tactics cards

Issues

To report issues (out of date or missing cards, typos, or any other bugs), please go to the Issues tab and click "New issue".

Development

If I get hit by a bus or something, you can take over this project by:

Forking it into your own repository
Creating your own bot on Discord via https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot
Go to the OAuth2 section, General, create a random redirect url (it's required but not used anywhere)
Go to URL Generator, check "Bot", then check "Read Messages/View Channels" and "Send Messages"
Click Copy to copy the URL and use it to add the bot to your server
For running locally, clone .env.sample as .env and set the value of DISCORD_TOKEN to your Discord token (double-quotes around it) -- note that you use !d for local commands instead of !a.
For running on the cloud, just ensure DISCORD_TOKEN is set to your bot's token in your cloud provider's environment variables
Even non-coders can update the data pretty easily -- it's in the src/asoiaf folder and broken up logically by faction and card type.

Updating Images

If you update an existing image URL with a new file, also update IMAGE_CACHE_SUFFIX to be the date of the change to ensure the cache is cleared.

Credits

Eric Lang, Michael Shinall, and the rest of the CMON team for a beautiful design
Discord's API for allowing me to build a bot
ASOIAFBuilder and On The Table Gaming for art and game data
My local game group at The Realm, Games and Comics in Brea, California, for their feedback

Legal

This bot is 100% unofficial and is not supported by or affiliated with CMON Games.

A Song of Ice and Fire: Tabletop Miniatures Game logo, CMON, and CMON logo are registered trademarks of CMON Global Limited.

asoiaf-tmg-discord-bot's People

Contributors

Stargazers

Watchers

Forkers

nrwillbanks

asoiaf-tmg-discord-bot's Issues

Add missing cards since Martell release

Anything else I need to add?

Requested by MCXL on Discord.

Add scenarios to the bot

Implicit request from Daddy Wil on ASOIAF Discord.

Add quick way to request a particular card type

Feedback from Reddit: https://www.reddit.com/r/asoiafminiaturesgame/comments/wxxi0y/comment/ilwdfws/?utm_source=reddit&utm_medium=web2x&context=3

Users would like to effectively say "Eddard ncu, please." instead of having to go through the cycle of:

First searching "Eddard"
Getting a response with the list of possible options
Typing/copying the option they want
Finally getting the card images

I'll need to think through the syntax, since I need to make sure the bot understands which part of the query is the card name and which part is the card type.

I may also need to teach it which cards are Commanders.

Right now the types the bot knows are:

enum CardTypes {
  CombatUnit = 'Combat Unit',
  Attachment = 'Attachment',
  NonCombatUnit = 'Non-Combat Unit',
  OpponentAttachment = 'Opponent Attachment',
  TacticsCard = 'Tactics Card',
}

Being a Commander would be an additional layer on top of that system.

Maybe that's enough? Are there any cards that have Commander and non-Commander versions and are still both Attachments or NonCombatUnits?

I'll ruminate on this.

Baratheon Banners

Can you add Joffrey's "Baratheon Banners" as a searchable card? (Used by his Kingsguard unit)

Consider adding "quiet message" style interaction

Original request:
Can you move some of the bot interaction, confirming which card you want and such to the quiet messages features? Some of the other bots I see do it and it reduces the bot clutter a lot

From alan on SoCal ASOIAF Discord.

Planning and insight card missing

"Planning and insight" card from neutrals deck is missing, at least I cannot find it

Possible issue with R'hollor Queen's Men

From Zosia on Discord: "Hi, I noticed that in your asoiaf tmg bot the unit of "r'hllor queen's men" doesn't have apostrophe in the word "queen's", which might cause some problems with searching them, and I feel like it's not there by the mistake. Just wanted to let you know in case you wanted to change it!"

Mag the Mighty (C)

Mag the Mighty should be tagged as a commander (Relevant only for -all requests, since his Combat Unit is identical to his Commander Combat unit).

Request will return 11 cards since he replaces the whole deck, so that's something to consider.

Pre-Season 1 Cards Used for Baelor & Victarion

The card used for Baelor Blacktyde is his old version with old "To The Last." Current Season 1 card face should be this:

Same with Victarion attachment (Season 1 updated "Relentless"):

Doran Commander not in the Bot

Like the title suggesting, Doran commander is not shown when searching "!a doran".
Only his regular NCU gets shown.

Thanks for making this bot.
We will hopefully implement it at our server soon :D

Typo found! "Eldon Estermont - Hefty Random" -> "Eldon Estermont - Hefty Ransom"

As in title

Dragonstone Noble Solo

Dragonstone Noble solo combat unit not showing up when queried. (Possibly because it has the same name as Dragonstone Noble attachment?)

Renly Lord Paramount issue

Requesting "-all" for "Renly Lord Paramount" calls up the correct commander attachment, but also all 9 Renly Tactics Cards for all 3 versions of Renly Commanders. (Tested the other 2 Renly Commanders & they call the correct set of cards with "-all".)

Typos

I found a few typos:

"High Sparrow - His High Holiness", should be "The High Sparrow - His High Holiness"
"Shyra Errol - Landy of Haystack Hall", has an extra "n"
"Olenna Tyrell - Olenna Tyrell" should be "Olenna Tyrell - Queen of Thorns"
"Alister Thorne - Vindictive Overseer" should be "Alliser Thorne - Vindictive Overseer"
"Ranger Vanguards" is missing the "s"
"Jorah Mormont - Pentient Betrayer" should be "Jorah Mormont - Penitent Betrayer"
"Jorah Mormont - Westerosi Tactician" missing the "i"

Create a cache busting mechanism

Whenever I fix a card image, it would be great to signal a cache bust via a URL parameter.

imageUrl?v=2022-10-16 for example

Add random terrain blurb to existing terrain image

The one that tells you what to roll and what you get. Perhaps how to roll for how many pieces you will have too.

Add Castle Wall

Make all tactics cards unique by labeling them with their faction or commander

This will ensure we don't run into any situations where an exact match wins when there are in fact multiple instances.

Add all 2021.S02 changes

https://asoif.s3.amazonaws.com/pdf/pdf/pdf/168/SIF-Leaflet-Update2021-S02-4-web.pdf

https://asoiaf.cmon.com/docs

Allow searching by abilities

Request from Mock on the ASOIAF Discord.

In principle, would just need to add abilities to each unit and then allow searching by these.

Commander calls

Would be cool if calling a commander (without any additional search words to specify further) brought up their Attachment Card & all 3/4 Tactics Cards by default.

Missing things after S03 update

Bot is missing recently released boxes:

Martell Heroes 2
Bolton Starter Set (Dreadfort Archers, new NCUs, new Tactic deck and commander cards, new attachment cards, and new cards for old bolton units)
Bolton Heroes 1
Dreadfort Spearmen
Targaryen Brazen Beasts
Lannister Golden Cloaks

Multiple things have been also changed in recent update, this is whole changelog of things that got changed, with new tactics card available here in respective factions pdf, and rest of cards available here, or all of them available on asoiaf-stats. There are many errors between files on their website and War Council, so it's likely that some of those cards will be changed in nearest time (or at least we can hope)