DtlTraders/config: Difference between revisions

From Citizens Wiki
No edit summary
(WIP - lethe)
Line 69: Line 69:
</span></div>     
</span></div>     
<p style="font-size:20px;color:red">This section is going to be changed for the v2.0 release</p>
<p style="font-size:20px;color:red">This section is going to be changed for the v2.0 release</p>
 
=== Locale ===
=== Locale configuration (same for bankers and traders) ===
<span style="white-space: pre;color:darkgreen;">
 
locale:
This will be moved out of the <code style="padding:2px">trader</code> section.
<span>  file: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">english.loc</tt><font color=black> - name of the language file.</font></span>
 
<span>  basedir: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">''</tt><font color=black> - path to the language file.</font></span>
changes the file name and path for the locale file.
</span><br />
 
'''Note:''' Bankers and traders use the same locale settings.
<pre> trader.locale.file: locale.eng
=== Wand ===
trader.locale.path </pre>
<span style="white-space: pre;color:darkgreen;">
 
wands:
=== Trader configuration ===
<span> manage: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">280</tt><font color=black> - ID of the item used to toggle the manager-mode. <b>Default:</b> Stick.</font></span>
Configuration used by <b>player</b>, <b>server</b> and <b>enchant</b> traders.
<spansettings: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">386</tt><font color=black> - ID of the item used to toggle the display mode of the bank-type traders. <b>Default:</b> Book and Quill.</font></span>
 
</span>
==== Wand item ====
=== Trader ===
<pre> manager-mode-toggle: 280 </pre>
<span style="white-space: pre;color:darkgreen;">
 
trader:
Config node will be renamed to <b>manager-wand</b> and moved out of the <code style="padding:2px">trader</code> section.
<span> inventory-navigation: </span>
 
<span>   sell-tab: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:5'</tt><font color=black> - ID of the item used to switch to the sell tab. <b>Default:</b> Lime Wool.</font></span>
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.
<span>   buy-tab: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:3'</tt><font color=black> - ID of the item used to switch to the buy tab. <b>Default:</b> Light Blue Wool.</font></span>
 
<span>   manage-price: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:15'</tt><font color=black> - ID of the item used to enter the price edit mode. <b>Default:</b> Black Wool.</font></span>
Default: _**stick**_
<span>   manage-buy-limit: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:12'</tt><font color=black> - ID of the item used to enter the limit edit mode. <b>Default:</b> Brown Wool.</font></span>
==== Navigation settings ====
<span>   manage-global-limit: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:11'</tt><font color=black> - ID of the item used to enter the global limit edit mode. <b>Default:</b> Blue Wool.</font></span>
<pre>
<span>   manage-player-limit: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:12'</tt><font color=black> - ID of the item used to enter the player limit edit mode. <b>Default:</b> Brown Wool.</font></span>
  sell-tab: '35:5'
<span>   return: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">35</tt><font color=black> - ID of the item used to return to the trader's main window. <b>Default:</b> White Wool.</font></span>
buy-tab: '35:3'
<span>   amounts-return: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:14'</tt><font color=black> - ID of the item used to return to the trader's main window from the amount selection menu. <b>Default:</b> Red Wool.</font></span>
</pre>
</span>
 
=== Banker ===
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>
Defines the item used to toggle on the <i>price management</i>.
 
<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>
 
<pre>
manage-global-limit: '35:11
manage-player-limit: '35:12
</pre>
Defines the items used to toggle <i>global</i> and <i>player</i> limits. (<b>server trader</b>).
 
Chang<pre>
return: 35
</pre>
 
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>
amounts-return: '35:14'
</pre>
Defines the item used to return from amount selection window.
 
 
 
=== Banker configuration ===
Configuration used by <b>player</b> and <b>guild</b> banks.
 
==== Tab size ====
<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 ====
<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 ====
<pre>
default-withdraw-fee: 0.0
default-deposit-fee: 0.0
</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 ====
<pre>
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
</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 ====
<pre>
player-accounts:
  file: player_accounts.yml
  path: ''
guild-accounts:
  file: guild_accounts.yml
  path: ''
</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 ===
<pre>
    money-bank:
      exchange-item: 388
      item-value: 10.0
</pre>
Defines the item and it's value when using the money-bank type trader to convert between money and items.
 
== Navigation ==
== Navigation ==
{| class="wikitable" style="text-align: center; width: 500px"
{| class="wikitable" style="text-align: center; width: 500px"
Line 186: Line 107:
| Types || | [http://wiki.citizensnpcs.com/DtlTraders/traders Traders] | [http://wiki.citizensnpcs.com/DtlTraders/bankers Bankers] <!--| [http://wiki.citizensnpcs.com/DtlTraders/auctionhouse Auction House] | [http://wiki.citizensnpcs.com/DtlTraders/wallets Wallets]-->
| Types || | [http://wiki.citizensnpcs.com/DtlTraders/traders Traders] | [http://wiki.citizensnpcs.com/DtlTraders/bankers Bankers] <!--| [http://wiki.citizensnpcs.com/DtlTraders/auctionhouse Auction House] | [http://wiki.citizensnpcs.com/DtlTraders/wallets Wallets]-->
|}
|}
/span>

Revision as of 12:09, 11 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.

Default config (v2.0)

#locale settings locale: file: english.loc basedir:

#wand settings wands: manage: 280 settings: 386

#trader settings trader:

#inventory "navigation" 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'

#banker settings bank:

#account defaults max-tabs: 9 tab-size: 3

#economy defaults withdraw-fee: 0.0 deposit-fee: 0.0

#tab prices 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

#backend settings player-accounts: file: player_accounts.yml basedir: guild-accounts: file: guild_accounts.yml basedir:

#default money banker settigns money-bank: exchange-item: 388 item-value: 10.0

#logger settings logging: basedir:

This section is going to be changed for the v2.0 release

Locale

locale: file: english.loc - name of the language file. basedir: - path to the language file.
Note: Bankers and traders use the same locale settings.

Wand

wands: manage: 280 - ID of the item used to toggle the manager-mode. Default: Stick. settings: 386 - ID of the item used to toggle the display mode of the bank-type traders. Default: Book and Quill.

Trader

trader: inventory-navigation: sell-tab: '35:5' - ID of the item used to switch to the sell tab. Default: Lime Wool. buy-tab: '35:3' - ID of the item used to switch to the buy tab. Default: Light Blue Wool. manage-price: '35:15' - ID of the item used to enter the price edit mode. Default: Black Wool. manage-buy-limit: '35:12' - ID of the item used to enter the limit edit mode. Default: Brown Wool. manage-global-limit: '35:11' - ID of the item used to enter the global limit edit mode. Default: Blue Wool. manage-player-limit: '35:12' - ID of the item used to enter the player limit edit mode. Default: Brown Wool. return: 35 - ID of the item used to return to the trader's main window. Default: White Wool. amounts-return: '35:14' - ID of the item used to return to the trader's main window from the amount selection menu. Default: Red Wool.

Banker

Navigation

DtlTraders
Usage Managing | Trading | Banking
Configuration Configuration | Commands | Permissions | Locale
Types Traders | Bankers