From 5cfb5805450a1c8df5ff4d90fbced8f935dadce0 Mon Sep 17 00:00:00 2001 From: Jesse McDonald Date: Sat, 3 Jun 2017 18:12:37 -0500 Subject: [PATCH] Update README.md based on UI changes. --- README.md | 127 +++++++++++++++++++++++++++--------------------------- 1 file changed, 63 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index 0dd185c..ca971b1 100644 --- a/README.md +++ b/README.md @@ -15,87 +15,86 @@ Nodes Using the Exchange ================== -Main Screen +Overview ----------- -The first screen you see is where you can search and post new buy/sell orders. -Here is an overview of each element: - - Market Summary - Pressing this will take you to the market summary screen. - - Your Orders - This will take you to a screen where you can view and cancel - your existing orders. - - Item - This field is for entering the item name (e.g. default:cobble) of the - item you want to search or post an order for. - - Amount - This field is for entering how many of the item you want to buy/sell - when posting an order. It has no purpose in searches. - - Select Item - This button takes you to a screen for choosing your item - graphically, instead of manually typing an item name. - - Rate - This field is for entering the desired price per item when posting an - order. For buy orders, this is the maximum price - your order will also accept - items that are cheaper. For sell orders, this is the minimum price - your - order will also accept buyers that are willing to pay more. The Rate field has - no effect on searches - - Search - This button searches existing orders for the selected item. If you - have the "Sell" box checked, it will only display buy orders, and will display - them in descending rate. If you have the box unchecked, it will show sell - orders in order of ascending rate. - - Post Order - This posts a new order for the item with the given amount and - rate. If the "Sell" box is checked, this is a sell order, so the exchange will - remove the items from your inventory. If it's unchecked, you are making a buy - order, so it will deduct credits from your account. If there are already - matching orders, it will immediately fill your order up to the amount possible, - and the remainder will stay as a new order. - - Sell - This checkbox determines what kind of orders to search for, and also - what kind of order you are posting. - - Search Results - This will display the results of your search. Clicking on an - element here will automatically fill the "Amount" and "Rate" fields, so that if - you click "Post Order", it will match the order you clicked. +At the top of the exchange form there are four tabs: Market Summary, Buy, Sell, +and Your Orders. Pressing each tab will take you to the indicated screen as +described below. Market Summary -------------- This summarizes the various items available on the exchange. From left to right, the columns display the item name, the description (what is shown in inventory), -the amount requested by buyers, the maximum rate offered by buyers, the amount -offered by sellers, and the minimum rate offered by sellers. It is updated -periodically. +the tool wear if applicable, the amount requested by buyers, the maximum rate +offered by buyers, the amount offered by sellers, and the minimum rate offered +by sellers. It is updated periodically. + +Buy +----------- +The upper-left corner shows the open order book for the selected item, +consisting of the three best sell offers (lowest asking price and least tool +wear) followed by the three best buy offers (highest offer price and highest +acceptable tool wear). To the right is an image of the selected item, entry +fields for the quantity and offer price, and a drop-down field for the desired +tool wear: "New" (no wear), "Good" (up to 10% wear), "Worn" (up to 50% wear), +and "Junk" (any amount of wear). To qualify, a seller must offer an item with +wear equal to or less than the indicated amount (e.g. if you select "Good" you +may receive an item with only 5% wear, but not one 15% worn). Similarly, the +offer price is the highest price you are willing to pay; in practice you may +pay less depending on the open sell orders. Orders are always fulfilled at the +price listed in the open order book. + +At the bottom of the form is a grid similar to the creative inventory. You can +page through the available items using the "<<" and ">>" buttons and select the +item you wish to buy simply by clicking on it. + +To finalize the order, press the "Place Bid" button. Note that it is permitted +to enter an order which exceeds your available funds at the time the order is +placed. As matching sell orders are located, the order will be fulfulled until +there are insufficient funds to cover the next item, at which point the +remainder of the order will be cancelled. + +Sell +----------- +As with the Buy screen, the upper-left corner shows the open order book for +the selected item. Instead of a static image, the selected item appears as a +1x1 inventory. At the bottom of the screen is the standard 8x4 player +inventory. To choose the type and quantity of items to sell, move the items +from your player inventory to the exchange inventory. Below the exchange +inventory is an entry field for the desired asking price. To finalize the +order, press the "Sell" button. As with buy orders, the asking price is the +lowest price you are willing to accept, and you may receive a higher price +depending on the open buy orders. + +Unsold items in the exchange inventory are returned to the player inventory +when the form is closed, or to the player's Inbox if the inventory is full. +(However, items in the exchange inventory at the time of a server crash, or +other abnormal condition, may be lost.) Your Orders ----------- This screen lets you see and cancel your orders. To cancel an order, click the -order and press the "Cancel" button. - -Select Item ------------ -This displays a creative-style inventory menu for selecting an item for searches -or posting orders. To select an item, drag it from the inventory to the box near -the bottom of the form +order and press the "Cancel" button. If the order was sell order, the items +held in "escrow" are returned to your player inventory. If any of the items do +not fit in the inventory they are placed in your Inbox instead to be claimed +later. Buying/Selling ============== Once you have opened the exchange, you have a few options. If you don't already know what you want to buy or sell, you can look at the Market Summary to get a glance at what people are offering. After you have decided on what you are -going to do, return to the exchange page. +going to do, return to the Buy or Sell page. -If you are selling an item, you should check the "Sell" checkbox. Otherwise, -leave it unchecked. Next, you need to select the item you want to deal in. There -are two ways: typing the item name (e.g. default:cobble) in manually to the item -field, or using the "Select Item" menu. If you haven't already decided on a price, -or you want to make sure your order is filled quickly, you can conduct a search. -To do this, click the "Search" button. This will give you a list of results. If -you checked the "Sell" box, then these will be buy orders, and will show the -maximum price per item each buyer is willing to accept. Otherwise, these will be -sell orders, displaying the minimum price each seller will accept. If you click -on a search result, it will automatically fill your Amount and Rate fields to -match. - -The Amount and Rate fields are used to decide how much and how expensively you -want to make your order. When selling, the Rate field is the minimum price you -will accept. When buying, it is the maximum. Once everything is filled out how -you want it, press the "Post Order" button. If there are matching offers (when -you post a buy/sell offer, there are one or more sell/buy offers with a price -at least as good), then that part of your offer will immediately be filled. For -example, if you post a buy order for 10 cobblestone at 5 credits each, and there -is a sell offer for 5 cobblestone 3 credits each, it will give you 5 cobble -immediately, and leave an order on the exchange for 5 more cobblestone. +When selling, the Ask field is the minimum price you will accept for each +item. When buying, the Bid field determines the maximum amount you are willing +to pay. If there are matching offers (i.e. there are one or more offers with a +price at least as good and a compatible tool wear level), then that part of +your offer will immediately be filled. For example, if you post a buy order +for 10 cobblestone at 5 credits each, and there is a sell offer for 5 +cobblestone at 3 credits each, it will give you 5 cobble immediately at a +total cost of 15 credits (the order-book price), and leave an order on the +exchange for 5 more cobblestone at 5 credits each. Once your offer is on the exchange, you can view or cancel it from the "Your Orders" menu.