DtlTraders/config: Difference between revisions

From Citizens Wiki
(Blanked the page)
Line 1: Line 1:
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 />


== Default config (v2.0) - (1.9.4+ compatible) ==
<div style="border: solid 1px black;padding:10px;padding-top:0px"><span style="white-space: pre;color:darkgreen;">
<span style="color:red">#locale settings</span>
locale:
<span>  file: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">english.loc</tt></span>
<span>  basedir: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">''</tt></span>
<span style="color:red">#wand settings</span>
wands:
<span>  manage: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">280</tt></span>
<span>  settings: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">386</tt></span>
<span style="color:red">#trader settings</span>
trader:
<span style="color:red">#trader patterns settings</span>
<span>  patterns:</span>
<span>    file: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'patterns.yml'</tt></span>
<span>    default: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px"></tt></span>
<span style="color:red">#inventory "navigation"</span>
<span>  inventory-navigation: </span>
<span>    sell-tab: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:5'</tt></span>
<span>    buy-tab: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:3'</tt></span>
<span>    manage-price: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:15'</tt></span>
<span>    manage-buy-limit: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:12'</tt></span>
<span>    manage-global-limit: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:11'</tt></span>
<span>    manage-player-limit: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:12'</tt></span>
<span>    return: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">35</tt></span>
<span>    amounts-return: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'35:14'</tt></span>
<span style="color:red">#banker settings</span>
bank:
<span style="color:red">#account defaults</span>
<span>  max-tabs: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">9</tt></span>
<span>  tab-size: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">3</tt></span>
<span style="color:red">#economy defaults</span>
<span>  withdraw-fee: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">0.0</tt></span>
<span>  deposit-fee: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">0.0</tt></span>
<span style="color:red">#tab prices</span>
<span>  tab-prices: </span>
<span>    tab2: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">100.0</tt></span>
<span>    tab3: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">200.0</tt></span>
<span>    tab4: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">500.0</tt></span>
<span>    tab5: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">1000.0</tt></span>
<span>    tab6: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">2000.0</tt></span>
<span>    tab7: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">5000.0</tt></span>
<span>    tab8: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">10000.0</tt></span>
<span>    tab9: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">50000.0</tt></span>
<span style="color:red">#backend settings</span>
<span>  player-accounts:</span>
<span>    file: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">player_accounts.yml</tt></span>
<span>    basedir: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">''</tt></span>
<span>  guild-accounts:</span>
<span>    file: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">guild_accounts.yml</tt></span>
<span>    basedir: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">''</tt></span>
<span style="color:red">#default money banker settigns</span>
money-bank:
<span>  exchange-item: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">388</tt></span>
<span>  item-value: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">10.0</tt></span>
<span style="color:red">#logger settings</span>
logging:
<span>  basedir: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">''</tt></span>
 
</span></div>   
<p style="font-size:20px;color:red">This section is going to be changed for the v2.0 release</p>
=== Locale ===
<span style="white-space: pre;color:darkgreen;">
locale:
<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">&nbsp;</tt><font color=black> - Path to the language file.</font></span>
</span><br />
'''Note:''' Bankers and traders use the same locale settings.
<div style="width:100%;border-top: solid 1px silver"></div>
=== Wand ===
<span style="white-space: pre;color:darkgreen;">
wands:
<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>
<span>  settings: <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>
<div style="width:100%;border-top: solid 1px silver"></div>
=== Trader ===
<span style="white-space: pre;color:darkgreen;">
trader:
<span>  patterns:</span>
<span>    file: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">'patterns.yml'</tt><font color=black> - the file name used to store patterns</font></span>
<span>    default: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px"></tt><font color=black> - default pattern applied to each <b>server trader</b> automatically</font></span>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</span>
<div style="width:100%;border-top: solid 1px silver"></div>
=== Banker ===
<span style="white-space: pre;color:darkgreen;">
bank:
<span>  max-tabs: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">9</tt><font color=black> - Maximum number of tabs the user will be able to use. <b>Default:</b> 9.</font></span>
<span>  tab-size: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">3</tt><font color=black> - Maximum number of rows in each tab. <b>Default:</b> 3. <b>Note:</b> As each row contains 9 cells, the final storage space will contain (tab-size)*9 items. Maximum of 5 rows can be used.</font></span>
<span>  withdraw-fee: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">0.0</tt><font color=black> - The cost of taking items out of the bank. <b>Default:</b> 0.</font></span>
<span>  deposit-fee: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">0.0</tt><font color=black> - The cost of putting items into the bank. <b>Default:</b> 0.</font></span>
<span>  tab-prices: </span><font color=black> - This section allows you to set the cost of unlocking each tab.</font>
<span>    tab1: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">0.0</tt><font color=black> <b>Note:</b> Setting this value higher than 0 will force the player to have at least this much money before beeing able to use the banker.</font></span>
<span>    tab2: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">100.0</tt></span>
<span>    tab3: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">200.0</tt></span>
<span>    tab4: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">500.0</tt></span>
<span>    tab5: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">1000.0</tt></span>
<span>    tab6: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">2000.0</tt></span>
<span>    tab7: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">5000.0</tt></span>
<span>    tab8: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">10000.0</tt></span>
<span>    tab9: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">50000.0</tt></span>
</span>
<div style="width:100%;border-top: solid 1px silver"></div>
=== Backend ===
<span style="white-space: pre;color:darkgreen;">
<span>  player-accounts:</span>
<span>    file: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">player_accounts.yml</tt><font color=black> - Name of the file containing player account information.</font></span>
<span>    basedir: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">&nbsp;</tt><font color=black> - Path the file containing player account information.</font></span>
<span>  guild-accounts:</span>
<span>    file: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">guild_accounts.yml</tt><font color=black> - Name of the file containing guild account information.</font></span>
<span>    basedir: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">&nbsp;</tt><font color=black> - Path to the file containing guild account information.</font></span>
</span>
<div style="width:100%;border-top: solid 1px silver"></div>
=== Money Bank ===
<span style="white-space: pre;color:darkgreen;">
money-bank:
<span>  exchange-item: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">388</tt><font color=black> - ID of the item used as a currency. <b>Default:</b> Emerald.</font></span>
<span>  item-value: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">10.0</tt><font color=black> - The currency's value. <b>Default:</b> 10.</font></span>
</span>
<div style="width:100%;border-top: solid 1px silver"></div>
=== Logging ===
<span style="white-space: pre;color:darkgreen;">
logging:
<span>  basedir: <tt style="color:black;background-color: #F8F8E0;border: solid 1px black;padding:0px 1px">&nbsp;</tt><font color=black> - Path to the log file.</font></span>
</span>
== Navigation ==
{| class="wikitable" style="text-align: center; width: 500px"
|-
! style="width: 100%; background-color:#ADD8E6" colspan="2" | '''DtlTraders'''
|-
| Usage || | [http://wiki.citizensnpcs.com/DtlTraders/managing Managing] | [http://wiki.citizensnpcs.com/DtlTraders/trading Trading] | [http://wiki.citizensnpcs.com/DtlTraders/banking Banking] <!-- | [http://wiki.citizensnpcs.com/DtlTraders/patterns Patterns] -->
|-
| Configuration || | [http://wiki.citizensnpcs.com/DtlTraders/config Configuration] | [http://wiki.citizensnpcs.com/DtlTraders/Commands Commands] | [http://wiki.citizensnpcs.com/DtlTraders/permissions Permissions] | [http://wiki.citizensnpcs.com/DtlTraders/locale Locale]
|-
| 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]-->
|}

Revision as of 23:28, 30 October 2013