TownGrant

General

This mod helps servers to pay out some money to newly founded settlements (town or country) when they are founded. The currency is configurable and can be auto created - also the currency can be soft-enforced on all settlements (see configuration).

For admins it is possible to revoke a grant and see some details in /edit as well by using the commands provided with /towngrant in chat.

To install the mod download the archive and extract it to the server rootfolder. Config will be created at first start.

 

 

Workflow

The mod listens to some game events to intercept them.

<table class="table-auto"> <tbody> <tr> <td>Startup</td> <td>The mod checks the configuration and creates the currency if he is set to do so.</td> </tr> <tr> <td>CreateCurrency</td> <td>Checks if the created currency is our needed one (depends on options / not used when currency will be created by the mod)</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">PlaceNewSettlementFoundation</td> <td style="text-align:left;vertical-align:top;">With this event the mod gets notified about a new (Country|Town)FoundationItem -&gt; creates a database entry.</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">SettlementFounded</td> <td>This event occurs when the settlement was founded -&gt; grant will be given out to the settlement</td> </tr> </tbody> </table>

 

Configuration

<table class="table-auto"> <tbody> <tr> <td style="text-align:left;vertical-align:top;">Enabled</td> <td style="text-align:left;vertical-align:top;">Enables/disables the mod (if you like to prepare stuff before using it)</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">GrantTown </td> <td style="vertical-align:top;text-align:left;">Enables/disables granting for towns</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">GrantCountry</td> <td style="vertical-align:top;">Enables/disables granting for countries</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">GrantCurrency</td> <td>The name of the used currency when transfering the grant (can be minted at runtime / see below)</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">CreateCurrency</td> <td>If enabled the mod creates the currency named at GrantCurrency (this needs CurrencyItem to be set and valid)</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">CurrencyItem</td> <td>The item that is used to mine the auto created currency - see CreateCurrency - default: GoldIgnotItem</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">GrantAmount</td> <td>The amount of money that is generated and transferred upon founding a town</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">GrantAmountCountry</td> <td>The amount of money that is generated and transferred upon founding a country</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">GrantInfo</td> <td>The message for the ledger</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">GrantUserName</td> <td>The user used to handle the transaction "from"-side (will be generated at runtime if does not exist)</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">ForceCurrency</td> <td>If enabled the currency for granting will be set on all settlements on server restart (fix old ones) and when a foundation is placed/town is founded</td> </tr> </tbody> </table>

 

Commands

The mod has some built in commands - all commands are prefixed with /towngrant

<table class="table-auto"> <tbody> <tr> <td style="text-align:left;vertical-align:top;">revoke <settlementNameOrId|townGrantNameOrId></td> <td style="text-align:left;vertical-align:top;">Revoke a grant for a settlement (withdraw the amount configured) / Admin-Only ( =&gt; before 1.5.0)</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">reset <settlementNameOrId></td> <td style="text-align:left;vertical-align:top;">Reset a grant for a settlement (withdraw the amount configured and mark it as not granted) / Admin-Only (new as of 1.5.0)</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">sync</td> <td>Syncs all TownGrants in the database and tries to handle out all grants (if the mod was disabled and it's needed to redo them)</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">list</td> <td>List all Grants with their current granting state. / Admin-Only (new as of 1.5.0)</td> </tr> <tr> <td style="text-align:left;vertical-align:top;">configure <option>,<value></td> <td>Provides admin-only options for mod settings.</td> </tr> </tbody> </table>