DtlTraders/config: Difference between revisions

From Citizens Wiki
No edit summary
(poprawione opisy i lekko zmieniony format, jeszcze do kolejnej rewizji - lethe)
Line 1: Line 1:
Here you got the default config file and a description. <br /><br /><b>!NOTE!</b> Any other config nodes appearing in the <i>config</i> are at this moment not used.<br />
This page contains the default configuration file and a brief description of available options. <br /><br /><b>Note:</b> Any other config nodes appearing in the <i>config</i> are at this moment not used.<br />


== General config ==
== General config ==
Line 51: Line 51:


==== Wand item ====
==== Wand item ====
config node will be renamed to <b>manager-wand</b> and moved out of the <code style="padding:2px">trader</code> section.
<pre> manager-mode-toggle: 280 </pre>


Allows to change the item which is used to toggle a trader into <i>manager-mode</i> or to open the <b>Player bankers</b> tab settings inventory. Default _**stick**_
Config node will be renamed to <b>manager-wand</b> and moved out of the <code style="padding:2px">trader</code> section.


<pre> manager-mode-toggle: 280 </pre>
Allows to change the item that is used to toggle the <i>manager-mode</i>. Manager-mode allows you to edit offered goods or in the case of the player banker change the appearence of the inventory tabs.


Default: _**stick**_
==== Navigation settings ====
==== Navigation settings ====
Allows to change the traders menu navigation items, in both trader modes. Default: different _**wool colors**_.
Changes the items used to switch through the <i>sell</i> and <i>buy</i> tab.
<pre>
<pre>
  sell-tab: '35:5'
  sell-tab: '35:5'
Line 67: Line 64:
</pre>
</pre>


Changes the item used to toggle on the <i>price management</i>.
Defines the items used to switch between the <i>sell</i> and <i>buy</i> tabs, in both trader modes.
Default: different _**wool colors**_.
 
<pre> manage-price: '35:15'</pre>
<pre> manage-price: '35:15'</pre>
Defines the item used to toggle on the <i>price management</i>.


Changes the item used to toggle the <i>buy</i> limit management. <i>(<b>player trader</b>)</i>
<pre> manage-buy-limit: '35:12'</pre>
<pre> manage-buy-limit: '35:12'</pre>
Defines the item used to toggle the <i>buy</i> limit management. <i>(<b>player trader</b>)</i>


Changes the items used to toggle <i>global</i> and <i>player</i> limits. (<b>server trader</b>).
<pre>
<pre>
  manage-global-limit: '35:11
  manage-global-limit: '35:11
  manage-player-limit: '35:12
  manage-player-limit: '35:12
</pre>
</pre>
Defines the items used to toggle <i>global</i> and <i>player</i> limits. (<b>server trader</b>).


Changes the item used to go back from an <i>specific management</i> to the <i>stock management</i>. Like from <i>price management</i>.
Chang<pre>
<pre>
  return: 35
  return: 35
</pre>
</pre>


Changes the item shown up when you want to go back from amount selection window.
Defines the item used to go back from <i>specific management</i> to the <i>stock management</i>. Like from <i>price management</i> to the general trader window.
 
<pre>
<pre>
  amounts-return: '35:14'
  amounts-return: '35:14'
</pre>
</pre>
Defines the item used to return from amount selection window.




Line 94: Line 96:


==== Tab size ====
==== Tab size ====
Allows to change the <i>"inventory size"</i> of the bank account. Values are valid from <b>1</b> up to <b>5</b>.
<pre> bank.tab-size: 3 </pre>
<pre> bank.tab-size: 3 </pre>
Allows to change the <i>"inventory size"</i> of the bank tab. Accepted values start at <b>1</b> and go up to <b>5</b>.


==== Available tabs ====
==== Available tabs ====
You can set how many tabs may a user buy. This is a global property, so you can change this amount for each player in the <b>player_accounts.yml</b> file. Commands will be added in future.
<pre> default-max-tabs: 9</pre>
<pre> default-max-tabs: 9</pre>
Defines how many tabs a user may buy. This is a global setting, so you can change this amount for each player in the <b>player_accounts.yml</b> file. Commands will be added in future.


==== Fees ====
==== Fees ====
You can set fees for <i>withdrawing</i> or <i>depositing</i> items in a bank tab.
<div><div style="color:red;display:table-cell">Note:</div> Fees are counted for each item, so adding two stacks of 1 dirt into a bank will cause to pay the fee 2 times!</div>
<pre>
<pre>
  default-withdraw-fee: 0.0
  default-withdraw-fee: 0.0
  default-deposit-fee: 0.0
  default-deposit-fee: 0.0
</pre>
</pre>
You can set fees for <i>withdrawing</i> or <i>depositing</i> items in a bank tab.
<div><div style="color:red;display:table-cell">Note:</div> Fees are counted separately for each item - putting two stacks of 10 dirt into the bank will incur twice the fee of putting just one stack of 20 dirt.</div>


==== Tab prices ====
==== Tab prices ====
Allows to set prices for each tab within the <b>player banker</b>. If there is an amount set to <i>tab1</i> a player can open a <i>account</i> only when he has got the required money.
<pre>
<pre>
  tab-prices:  
  tab-prices:  
Line 124: Line 124:
   tab9: 50000.0
   tab9: 50000.0
</pre>
</pre>
 
Allows to set prices tu unlock each tab in the <b>player banker</b>. Setting any amount other than 0 under <i>tab1</i> requires a player to have this much money before opening an account.
==== Bank accounts files ====
==== Bank accounts files ====
Accounts for players will be saved by default in <b>player_accounts.yml</b>, and for guilds/factions/etc. in the <b>guild_accounts.yml</b> file. You can change the file names and path for both of these files.
<pre>
<pre>
  player-accounts:
  player-accounts:
Line 135: Line 134:
   path: ''
   path: ''
</pre>
</pre>
 
Player's accounts will be saved in <b>player_accounts.yml</b> file by default, guilds/factions/etc. accounts in the <b>guild_accounts.yml</b> file. You can change the file names and path for both of these files.
 
=== Money bankers ===
=== Money bankers ===
This kind of banker is different than all others, it hasn't got a <i>manager-mode</i> or <i>settings-mode</i> but it's more like an exchange between the players money and a item you set in the config, with a exchange value. So lets say you set an <b>emerland</b> for the price of <b>10.0</b>$. Now when you and add <b>10 emerlands</b> to this bank, you will get <b>100</b>$.
<pre>
<pre>
     money-bank:
     money-bank:
Line 144: Line 141:
       item-value: 10.0
       item-value: 10.0
</pre>
</pre>
Defines the item and it's value when using the money-bank type trader to convert between money and items.

Revision as of 13:28, 10 September 2012

This page contains the default configuration file and a brief description of available options.

Note: Any other config nodes appearing in the config are at this moment not used.

General config

   trader: 
     locale:
       file: locale.eng
     manager-mode-toggle: 280
     inventory-navigation: 
       sell-tab: '35:5'
       buy-tab: '35:3'
       manage-price: '35:15'
       manage-buy-limit: '35:12'
       manage-global-limit: '35:11'
       manage-player-limit: '35:12'
       return: 35
       amounts-return: '35:14'
   bank: 
     tab-size: 3
     default-withdraw-fee: 0.0
     default-deposit-fee: 0.0
     default-max-tabs: 9
     tab-prices: 
       tab2: 100.0
       tab3: 200.0
       tab4: 500.0
       tab5: 1000.0
       tab6: 2000.0
       tab7: 5000.0
       tab8: 10000.0
       tab9: 50000.0
     player-accounts:
       file: player_accounts.yml
   money-bank:
     exchange-item: 388
     item-value: 10.0   
       

Locale configuration (same for bankers and traders)

This will be moved out of the trader section.

changes the file name and path for the locale file.

 trader.locale.file: locale.eng
 trader.locale.path 


Trader configuration

Configuration used by player, server and enchant traders.

Wand item

 manager-mode-toggle: 280 

Config node will be renamed to manager-wand and moved out of the trader section.

Allows to change the item that is used to toggle the manager-mode. Manager-mode allows you to edit offered goods or in the case of the player banker change the appearence of the inventory tabs.

Default: _**stick**_

Navigation settings

 sell-tab: '35:5'
 buy-tab: '35:3'

Defines the items used to switch between the sell and buy tabs, in both trader modes. Default: different _**wool colors**_.

 manage-price: '35:15'

Defines the item used to toggle on the price management.

 manage-buy-limit: '35:12'

Defines the item used to toggle the buy limit management. (player trader)

 manage-global-limit: '35:11
 manage-player-limit: '35:12

Defines the items used to toggle global and player limits. (server trader).

Chang

 return: 35

Defines the item used to go back from specific management to the stock management. Like from price management to the general trader window.

 amounts-return: '35:14'

Defines the item used to return from amount selection window.


Banker configuration

Configuration used by player and guild banks.

Tab size

 bank.tab-size: 3 

Allows to change the "inventory size" of the bank tab. Accepted values start at 1 and go up to 5.

Available tabs

 default-max-tabs: 9

Defines how many tabs a user may buy. This is a global setting, so you can change this amount for each player in the player_accounts.yml file. Commands will be added in future.

Fees

 default-withdraw-fee: 0.0
 default-deposit-fee: 0.0

You can set fees for withdrawing or depositing items in a bank tab.

Note:
Fees are counted separately for each item - putting two stacks of 10 dirt into the bank will incur twice the fee of putting just one stack of 20 dirt.

Tab prices

 tab-prices: 
   tab1: 0.0
   tab2: 100.0
   tab3: 200.0
   tab4: 500.0
   tab5: 1000.0
   tab6: 2000.0
   tab7: 5000.0
   tab8: 10000.0
   tab9: 50000.0

Allows to set prices tu unlock each tab in the player banker. Setting any amount other than 0 under tab1 requires a player to have this much money before opening an account.

Bank accounts files

 player-accounts:
   file: player_accounts.yml
   path: ''
 guild-accounts:
   file: guild_accounts.yml
   path: ''

Player's accounts will be saved in player_accounts.yml file by default, guilds/factions/etc. accounts in the guild_accounts.yml file. You can change the file names and path for both of these files.

Money bankers

    money-bank:
      exchange-item: 388
      item-value: 10.0

Defines the item and it's value when using the money-bank type trader to convert between money and items.