DtlTraders/config: Difference between revisions

From Citizens Wiki
(WIP - lethe)
(WIP - lethe)
Line 73: Line 73:
locale:  
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>  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>
<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 />
</span><br />
'''Note:''' Bankers and traders use the same locale settings.
'''Note:''' Bankers and traders use the same locale settings.
Line 96: Line 96:
</span>
</span>
=== Banker ===
=== 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>
=== 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> - location of 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> - location of the file containing guild account information.</font></span>
</span>
== Navigation ==
== Navigation ==
{| class="wikitable" style="text-align: center; width: 500px"
{| class="wikitable" style="text-align: center; width: 500px"

Revision as of 12:50, 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

bank: max-tabs: 9 - maximum number of tabs the user will be able to use. Default: 9. tab-size: 3 - maximum number of rows in each tab. Default: 3. Note: As each row contains 9 cells, the final storage space will contain (tab-size)*9 items. Maximum of 5 rows can be used. withdraw-fee: 0.0 - the cost of taking items out of the bank. Default: 0. deposit-fee: 0.0 - the cost of putting items into the bank. Default: 0. tab-prices: - This section allows you to set the cost of unlocking each tab tab1: 0.0 Note: Setting this value higher than 0 will force the player to have at least this much money before beeing able to use the banker. 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

player-accounts: file: player_accounts.yml - name of the file containing player account information. basedir:   - location of the file containing player account information. guild-accounts: file: guild_accounts.yml - name of the file containing guild account information. basedir:   - location of the file containing guild account information.

Navigation

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