Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

QuickShop Guide Update #3

Merged
merged 12 commits into from
Sep 29, 2024
4 changes: 2 additions & 2 deletions docs/survival/claim-commands.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
---

# What commands do I use to claim land?
Expand Down Expand Up @@ -43,4 +43,4 @@ Deletes all of your claims.

Buy claim blocks using your balance to add to your existing claim blocks.

Adapted from GriefPrevention Wiki Commands: https://github.com/TechFortress/GriefPrevention/wiki/Commands
Adapted from GriefPrevention Wiki Commands: https://github.com/TechFortress/GriefPrevention/wiki/Commands
62 changes: 20 additions & 42 deletions docs/survival/create-shop.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,58 +10,36 @@ Start by placing a chest on the ground in your desired location.

![Chest](./img/shop/place-chest.png)

# Position the Sign
Position a sign one block away from the chest.
# Run /qs create [price] [item]
Run the command `/qs create [price][item]`. Alternatively, if you hold the item in your hand you only need the price: `/qs create [price]`.

:::info

In the example screenshot, it has been placed directly above the chest for clarity.
For instance, in Fig 1: The shop is selling 64 diamonds at $1 each.

:::
# Shop Settings
If you Right-Click the shop sign you will see a menu pop up in chat that displays
![shop mode](./img/shop/shop-settings.png)
# Shop Modes
To switch between selling or buying items look at the shop sign and type `/qs buy` or `/qs sell` respectively.

![position sign on chest](./img/shop/position-sign.png)
Below are examples of the different modes:
![shop mode](./img/shop/shop-mode-1.png)

# Sign Format
On the sign above the chest, use the following format:

```
[Your Username]
[Amount to Buy/Sell per Transaction]
[Buy Price - Sell Price]
[Item ID/Name]
```

:::info

For instance, in Fig 1: Buying 1 Diamond for $10 and selling 1 Diamond for $5.

:::

![Sign format](./img/shop/sign-format-1.png)

This format is an example for buying and selling an item.
This format is an example of a shop where you can sell items to earn money.

![sign format](./img/shop/sign-format-2.png)

This format is an example for just selling an item.

## Confirmation Message
If you've set up your shop correctly, you should receive a message in the chat confirming that your shop has been successfully created, such as "Shop successfully created!"
![shop mode](./img/shop/shop-mode-2.png)

# I am having issues what to call my shop item.
**Trouble Naming Items:** If you're unsure about how to name an item on the sign in your shop, you can use the `/iteminfo` command. This command helps you identify the item's name and what to put on the shop sign.

![What to call shop item](./img/shop/call-shop-item.png)
This format is an example of a shop where players can sell you items in exchange for money from your balance.

In this example Dirt is being used the item and the name of the item to be used on the Shop Sign.
# Changing the Price
If you wish to change the price of your shop after you have created it, type `/qs price [new price]`.

# Shop Sign Breakdown
* The first line should contain your username.
* The second line specifies the amount of items to buy or sell per transaction.
* For example, in Fig 1: Buying 1 Diamond for $10 and selling 1 Diamond for $5.
* The third line combines buy and sell prices and should include a price indicator (B for buy price, S for sell price) near the prices, separated by a colon (e.g., B:$10 - S:$5).
* The fourth line should hold the item's ID or name.
## Confirmation
If you've set up your shop correctly, you should see a shop sign appear in front of the chest.

If you ever get stuck during this process, you can simply write a "?" on the sign, and the item will be automatically filled from the chest, or you can click on the sign with the item in hand afterward.
# I am having issues what to call my shop item.
**Trouble Naming Items:** If you're unsure about how to name an item on the sign in your shop, you can hold the item in your hand while you use `/qs create [price]` to create your shop

With these steps, you'll be well on your way to successfully creating and managing your shop in the game. Happy trading!
With these steps, you'll be well on your way to successfully creating and managing your shop in the game. Happy trading!
4 changes: 2 additions & 2 deletions docs/survival/faq.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
---

# Frequently Asked Questions
Expand All @@ -8,4 +8,4 @@ sidebar_position: 5
Our goal has always been for more community focus on things like our warps via Spawn and our Nether highway.
Together as an administrative team we've decided to not implement TPA and instead recommend that players use the Nether Highway and have your portal set-up, or you can use the warps at Spawn.

You can also suggest to setup permanent warp points by opening a ticket on our Discord (https://craftingforchrist.net/discord) and we can look into this.
You can also suggest to setup permanent warp points by opening a ticket on our Discord (https://craftingforchrist.net/discord) and we can look into this.
Binary file added docs/survival/img/shop/shop-mode-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/survival/img/shop/shop-mode-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/survival/img/shop/shop-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/survival/img/shop/using-a-shop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/survival/remove-shop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
sidebar_position: 4
---

# Removing a Player Chest Shop
Use `/qs remove` to remove your closest shop. Then you can simply destroy the chest as you would regularly.

If you would like to remove all of your shops you can use, `/qs removeall`.
9 changes: 3 additions & 6 deletions docs/survival/use-shop.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ Make sure you have sufficient funds before making purchases. To check, use the /

:::

To use a Player's Chest Shop, simply go up to their chest item and there are 2 actions of the following:

| Click | Action |
| ----------- | ------------------------------------------- |
| Left Click | Will buy an item for the amount specified. |
| Right Click | Will sell an item for the amount specified. |
To use a Player's Chest Shop, simply go up to their chest and left-click the sign. The shop will prompt you to enter the number of items you wish to purchase in chat.
![position sign on chest](./img/shop/using-a-shop.png)
After entering the desired number of items in chat you will receive your items.