diff --git a/albums.md b/albums.md new file mode 100644 index 0000000..9820491 --- /dev/null +++ b/albums.md @@ -0,0 +1,26 @@ +# Albums + +## What are they? +Albums are like an extra to badges, only you don't know what card goes in what album. :eyes: +When you run `[]albums` you will see something like this... +>
+
!===== [Albums (Page 1/1)] =====!
+
+\- 1. ??????? - 0/12 Cards +\- 2. ?????? - 0/12 Cards +\- 3. ???????? - 0/10 Cards +\- 4. ???????? - 0/6 Cards +
+
!===== [Albums (Page 1/1)] =====!
+
+ + + +When you run `[]album [number]` *replacing `[number] with an album number`, the bot will take some time to generate the image*, the bot will send a message with the album title if you have completed it; the number of cards you have already put into the album; and the image of the album itself. +>Here's a blank album 1 for reference: +![](https://cdn.discordapp.com/attachments/275733751814815766/349855830797189120/1.png) + +## How do I add a card to one of my albums? +Simply run `[]cardtoalbum [card-name|#card-id]`. +If the card isn't required for any albums, the bot will return with the message: +>No albums needs this card. diff --git a/all-commands.md b/all-commands.md index 229024c..5f92196 100644 --- a/all-commands.md +++ b/all-commands.md @@ -78,7 +78,10 @@ This is a list of all the command currently in the bot. | Command | Description | Usage | Cooldown | Aliases | |---------|-------------|-------|----------|---------| +| album | Shows information about an album. | `[]album [id]` | 5 | *none* | +| albums | Lists all albums. | `[]albums` | 2 | *none* | | balance | Get your own balance (or someone elses) | `[]balance <@mention>` | 10 | `[]bal`, `[]money` | +| cardtoalbum | Makes a card into a piece of the album. | `[]cardtoalbum [card name]` | 2 | `[]card2album`, `[]c2a` | | inv | Get your own inventory (or someone elses) | `[]inv <@mention> ` | 3 | *none* | | pbadges | Get your badges (or someone elses) | `[]pbadges <@mention>` | 10 | `[]mybadges` | | setting | Edit or view settings. | `[]setting [setting] ` | 1 | `[]set` | diff --git a/badges.md b/badges.md new file mode 100644 index 0000000..8b9e6e8 --- /dev/null +++ b/badges.md @@ -0,0 +1,21 @@ +# This page is still in progress :( + + - Card Collector Badges + - Special Badges + +## Card Collector Badges +**How do I get these?** +By collecting all cards within a collection. +Once you have, run `[]fusecards [series]`. + +**Which ones are available to me?** +Any of the series badges. + +## Special Badges + +**What are these?** +Badges that are given by the developers to players. + +**What ones can I get?** +`Donator Badge` - Given to people that donated via Patreon +`Beta Tester Badge` - If you were in the beta version of the bot, you would recieve this for assisting with *sniffing out bugs* in the bot's code. diff --git a/cards.md b/cards.md index 916f090..f031907 100644 --- a/cards.md +++ b/cards.md @@ -1 +1,33 @@ -# This page is still in progress :( \ No newline at end of file +# Cards + + +## Rarities +|
Common
|
Uncommon
|
Rare
|
Super Rare
| +| ----------------- | ------------------- | --------------- | --------------------- | +|
![](https://discord.cards/i/c/21.png)
|
![](https://discord.cards/i/c/15.png)
|
![](https://discord.cards/i/c/27.png)
|
![](https://discord.cards/i/c/10.png)
| + +Any of these rarities can be obtained through the market or by opening packs. *More on that in [Opening Packs](#opening-packs).* +####
Limited
+*Now these are special ones.* +These cards are only obtainable through the global market. +To get notifications on when these cards are *dropped* into the game, goto [the support server](https://join.discord.cards/) and in the `#off-topic` channel type `b!limited-notifs`, and you're done. + +*Here's Wolfiri, she's one of the limited cards!* +
![](https://discord.cards/i/c/L1.png)
+ +## Opening Packs +Want to open a pack *not a problem*, simply run `[]openpack [series]`. +If you don't already have a pack, run `[]series` to see what packs there are and then `[]stats` to see if you have enough to buy a pack. If all these match, run `[]buypack [series]`. +Want to get more than one *should have asked before :P*, simply add a number on the end of the command, like this `[]buypack [series] `. *Sadly this doesn't exist for `[]openpack` due to the Discord API limitations and image generation, sending more than one image isn't really logical.* + +## Global Market Stats + +There are market stats on each showing what the count, lowest and average buying and selling prices are when you type the command. *Not including trades.* + +>Selling / Buying Offer Market Data +>- Count - The number of cards being sold +>- Average - The average selling price +>- Lowest - The lowest selling price + +
![](https://i-need.discord.cards/49469e.png)
+Here is an example view of a card, *timestamps and number of cards owned has been blurred out for this.* diff --git a/clubs.md b/clubs.md index 916f090..3a6c2b7 100644 --- a/clubs.md +++ b/clubs.md @@ -1 +1,93 @@ -# This page is still in progress :( \ No newline at end of file +# Clubs + +## What are clubs? +Clubs are groups of people that enjoy collecting cards of any type, a certain type, to sell on the market to earn a profit or just a group of friends. + +**How many can I join?** +You can join up to 5 clubs at any one time. + +**How do I view a club?** +Run `[]club [club-name]` *but that's just the start*. + +**How do I join a club?** +Run `[]cjoin [club-name]` - clubs with invites disabled require an admin or owner to invite you. + +**How do I leave a club?** +Run `[]cleave [club-name]` + +**How do I view my own clubs?** +Run `[]pclubs`. *Simples* + +**How do I view someone else's clubs?** +Run `[]pclubs @user` + +## Making your own club +*This part is straight forward.* +Run `[]ccreate [name]` *replace `[name]` with your chosen club name* and that's it. + +**I don't want my club anymore.** +There are two ways of giving your club up. + 1. Run `[]cleave` *only do this if you are certain that you want it removed*. + 2. Run `[]cgiveowner @user [club-name]` to transfer ownership of the club to another club member. + +**How do I invite a user?** +Run `[]cinv @user [club-name]`. + +**How do I see what invites are still pending?** +Run `[]cinvlist [club-name] <| [page]>` - the page is optional. + +**How do I remove an invite?** +Run `[]crinv @user [club-name]` + +## Customizing your club + +**How do I change the name of my club?** +Run `[]ceditname [club-name] | [new-name]` + +**How do I edit the description of my club?** +Run `[]ceditdesc [club-name] | [desc]` + +**How do I edit the club banner?** +Goto the [banner editor](https://discord.cards/banner-edit) and choose your banner type, color, design and design color. +In the `Club Name` field enter the club name of which you want to edit. +Lastly, copy the command below your brand new banner and paste it into a channel that Discord Cards has access to. *Press enter of course.* + +## Managing your club + +**How do I view the member list?** +Run `[]cmembers [club-name] <| [page]>` - the page is optional. + +**How do I view the ban list?** +Run `[]cbanlist [club-name] <| [page]>` - the page is optional. + +**How do I kick/ban/unban a member?** +To kick a member, run `[]ckick @user [club-name]`. +To ban a member, run `[]cban @user [club-name]`. +To unban a member, run `[]cunban @user [club-name]`. + +**What ranks are there for clubs and how do I set someones rank?** + +The available ranks are: + - Owner + - Admin + - Member + +You can set someone's role by using the following command: +`[]crank [name] | @user [Admin|Member]` *not Owner, that's for `[]cgiveowner`* + +**How can I set my club's settings?** +Use `[]csetting [name] | [setting] ` + +#### BUT THERE'S MORE!! + +#### Club Settings +- `displayColor` = Change the color that is used on the side of the embed. +- `baseName`, `designName`, `baseColor`, `designColor` = All of these properties decend from the banner editor *simple and short*. +- `open` = Toggle if players can join your club or not. + - `yes` - open + - `no` - closed + + +#### Commands + +• []csetting diff --git a/global-market.md b/global-market.md index 916f090..2393c0d 100644 --- a/global-market.md +++ b/global-market.md @@ -1 +1,79 @@ -# This page is still in progress :( \ No newline at end of file +# Global Market +The global market is what keeps the economy of the game flowing *tl;dr moving money*. + +## Types of offers + +- Buying +These offers have money put on the trade and the offer author will ask for a certain card and the price they will pay for each card you give them. + +- Selling +These offers have cards put on the trade and the offer author will ask for a sum of money per card on the offer. + +## Understanding the offer +
+
+**Selling Trade** +
+![](https://i-need.discord.cards/8a7d11.png)
+ +
+
+**Buying Trade** +
+![](https://i-need.discord.cards/bd4eed.png) +
+ + +**Details on these trades.** +- Type - *the type of trade* +- Buyer / Seller - *the author of the trade* +- Created - *when the trade was made (UTC String)* +- Stock - *the amount of cards in the deal* +- Amount Bought / Sold - *the amount of cards that are already sold/bought* +- Item - *the item that is being traded* +- Price *per card* + +## Using the market + +**I want to execute a trade.** +For the buying market, use `[]boexecute [amount]` +For the selling market, use `[]soexecute [amount]` + +**How do I view a trade?** +For the buying market, use `[]boffer ` +For the selling market, use `[]soffer ` + +**How do I start a trade?** +For the buying market, use `[]` +For the selling market, use `[]` + +**How do I stop a trade?** +For the buying market, use `[]` +For the selling market, use `[]ostop` + +**How do I view all of my trades?** +For the buying market, use `[]` +For the selling market, use `[]` + +**How do I view all trades on the market?** +For the buying market, use `[]bolist [page]` +For the selling market, use `[]solist [page]` + +**How do I search for an item on the market?** +For the buying market, use `[]bosearch [query] [page]` +For the selling market, use `[]sosearch [query]` + +The following below can be used as search modifiers: +- `#CARD_ID` - Searches card offers with that ID +- `$RARITY` - Searches card offers with that rarity +- `%SERIES` - Searches card and card pack offers with that series ID + +**Example Searches:** +- `[]sosearch b1nzy` +Searches for any card with the name of `b1nzy`. +- `[]bosearch #63` +Searches for any card with the ID 63. +- `[]sosearch $c` +Searches for any card with the Common rarity. +- `[]bosearch %1` +Searches for any card in the Discord series. diff --git a/index.md b/index.md index 5e4ec82..9c303b7 100644 --- a/index.md +++ b/index.md @@ -1,5 +1,14 @@ # This is the Discord Cards Guides -This site is community-driven by people like you! +This site is community-driven by people like you! +You can also contribute to the guide by contributing to the [GitHub Repo](https://github.com/DiscordCards/Guide). -You can also contribute to the guide by contributing to the [GitHub Repo](https://github.com/DiscordCards/Guide). \ No newline at end of file +### Links +[Invite the bot](https://invite.discord.cards) +[Join the support server](https://join.discord.cards/) +[Bug Tracker](https://github.com/DiscordCards/Tracker) + +### Tools +[Banner Editor](https://discord.cards/banner-edit/) +[Database Lookup](https://lookup.discord.cards/) +[Discord Injections: Discord Cards Plugin](https://github.com/DiscordInjections/Plugins/tree/master/DiscordCardsDashboard) diff --git a/minigames.md b/minigames.md index 916f090..2645b86 100644 --- a/minigames.md +++ b/minigames.md @@ -1 +1,16 @@ -# This page is still in progress :( \ No newline at end of file +# Minigames +Other ways to earn money. + +## Cardguess +*Running this command will make you put your thinking cap on.* +To play, run `[]cardguess` and try to guess the card in the chat. +You have 3 tries and 30 seconds to guess the card. If either the time or your tries run out, the game will stop. +If you use all of you tries the bot will return the card name. +However, if you run out of time the bot will respond with: +>@user, You failed to respond in 30 seconds! Please try again! + +You may type `cancel` at anytime to stop the game. + +## Slots +*A very simple game, but be careful on how much you bet.* +To play, run `[]slots [bet]`. diff --git a/quests.md b/quests.md index 916f090..6e40e2d 100644 --- a/quests.md +++ b/quests.md @@ -1 +1,28 @@ -# This page is still in progress :( \ No newline at end of file +# Quests + +## Getting a quest +You can get a quest by doing `[]getquest`, `[]questget` or `[]qget`. *You can only get one at a time.* +*The cooldown is 6 hours, so there's enough time to consider if you want do it.* + +## Viewing a quest +Run `[]quest` *that's it*. + +## Completing a quest +To complete a quest, simply gather all the cards and run the following command `[]qcheck`. + +If you don't have a quest, the bot will return with the message. +>You don't have an active quest! + +If you have an active quest but not the cards specified, the bot will return: +>You don't have these cards: [Cards separated by commas] + +For example: +>You don't have these cards: `Audit Logs`, `Chill Zone`, `Cluckcord`, `Phones` + +If you manage to gather all the cards, **congratz** but you'll need to give them to the global card database for redistribution. +To complete your quest *once and for all*, run `[]qcheck`. ~~*and start over*~~ and you'll be rewarded with that nice sum of money that you were promised at the start of your quest. *No seriously, that's not the end.* +You'll also be sent a message, like this one below: +>Quest completed! **+500** :dollar: + +*Obviously you'd replace the 500 value with whatever you actually got.* +You may do as many quests as you like. *Or don't do any at all.* diff --git a/stats.md b/stats.md index 916f090..4466470 100644 --- a/stats.md +++ b/stats.md @@ -1 +1,62 @@ -# This page is still in progress :( \ No newline at end of file +## Balance +*It's what keeps the game economy moving.* + +There are many ways to earn money in the game. +To get your daily sum of money, run `[]daily` every 24 hours. + +**I can't remember when I can do `[]daily` again.** +The bot will tell you how much time there is left until you can do daily next. +It will also tell you what your current streak is. + +**What are streaks?** +Streaks are earned by using the command each day to gain a higher streak. +You can lose a streak by missing more than a day. +>This player didn't use the command for 13 days *just shows how easy it is to just leave, you should aim to not be like this player*. + +>![](https://i-need.discord.cards/449538.png) + +## Inventory +*Your very own collection.* + +**How do I see another page number?** +Use `[]inv [page-number]` to see what you've got in your inventory. + +**How do I see another player's inventory?** +Use `[]inv @user [page-number]` to see theirs *don't mention them if they didn't ask for it*. + +## Settings +*Customize your gameplay.* + +This command has four settings that you can customize. + +- `displayColor` = Change the color that is used on the side of the embed. +- `trades` = Toggle with `yes` or `no` to let the bot know if you are accepting trades *this will also make you unable to start trades, you will still be able to use the market.* +- `notifs` = Toggle with `yes` or `no` to let the bot know if you want to recieve notifications on your global market offers. +- `locale` = Set your game locale *read more below*. + +**I don't speak English fluently.** +We've got you covered. +Run `[]setting locale list` to see all the locales that are available. +Run `[]setting locale [locale-name]` to set your game locale. +Run `[]setting locale unset` to clear your game locale. + +**You have some strange language names, is that on purpose?** +Yes, that is totally intentional. +The following languages were made just to have a laugh *they are based on the english locale, as you'd expect*: + - Catlang `meow` + - Pirate `pr` + +**I don't see my language in the list.** :cry: +We're sorry to hear that, maybe you could head over to [the support server](https://join.discord.cards) and see if anyone can help with translation. + +**Can I assist with translating the bot to another language?** +Of course, right now we need all the help we can get. To get started, head over to [the support server](https://join.discord.cards) and head to either `#support` or `#general`, ask if you can help with translating language x, y or z... one of the developers will try to respond as soon as possible *most likely Snazzah*. + +**How do I change settings for my whole server?** +It's a different command altogther, `[]ssetting`. +This command has four settings that you can customize. + +- `prefix` = Change the default prefix to something a little more __**personalized**__ +- `adminrole` = Change the default admin role *users with this role can change the server settings*. +- `react` = Decide if the bot should react to the global market listing or a player's inventory. +- `locale` = Like the user setting, but the bot will use the locale across the server *if a user has not specified a locale to use*. diff --git a/trading.md b/trading.md index 916f090..b39ca55 100644 --- a/trading.md +++ b/trading.md @@ -1 +1,28 @@ -# This page is still in progress :( \ No newline at end of file +# Trading + +## Executing a trade +*Not a market trade.* + +To start, run `[]tstart @user` on the user you want to trade with and wait. +If you have been invited to a trade, run `[]taccept`. If you've been invited to trade with another user but you don't want to, run `[]tdeny` to turn down the request. + +If at any point you want to look at the current trade details between you and the other player, run `[]trade` + +If at any point during a trade you feel that the other player does not have what you are looking for or they are not offering an item that you want, run `[]tdeny` to stop the trade. + +To add an item to the trade, run `[]tadditem [item name] [amount]` - Enter a number at the end if you want to trade more than one of that item. + +If you want to remove an item *my precious*, run `[]tremoveitem [item name] [amount]` - This command follows the same format as `[]tadditem` above. + +To add money to the trade, run `[]tsetmoney [amount]`. *The value that you enter will be the value that is traded, no add or subtract unfortunately.* + +Once you are both finished adding items and money, both users in the trade are required to run `[]tok` to execute the trade. + +**And you're done!!** *Not really, but that's how to run a successful trade.* + +## Donating / Gifting +*Give to those that deserve it most.* + +Donating money or items couldn't be easier. +To donate a sum of money to a player, run `[]donate @user [amount]`. +To gift an item like a card or even a whole pack, run `[]gift @user [item name] [amount]`