Config

Config file

The config file as well as the messages file includes comments above each config line, it should therefore be easy to understand and modify. Here is a complete config file with all comments:

# RealEstate wiki and newest versions are available at http://www.github.com/EtienneDx/RealEstate
RealEstate:
  Keywords:
    # What is displayed before any chat message
    ChatPrefix: '$f[$6RealEstate$f] '
    # What is displayed in top of the signs
    SignsHeader: $6[RealEstate]
    # List of all possible possible signs headers to sell a claim
    Sell:
    - '[sell]'
    - '[sell claim]'
    - '[sc]'
    - '[re]'
    - '[realestate]'
    # List of all possible possible signs headers to rent a claim
    Rent:
    - '[rent]'
    - '[rent claim]'
    - '[rc]'
    # List of all possible possible signs headers to rent a claim
    ContainerRent:
    - '[container rent]'
    - '[crent]'
    # List of all possible possible signs headers to lease a claim
    Lease:
    - '[lease]'
    - '[lease claim]'
    - '[lc]'
    Replace:
      # What is displayed on signs for preoperties to sell
      Sell: FOR SALE
      # What is displayed on signs for preoperties to rent
      Rent: FOR RENT
      # What is displayed on signs for preoperties to lease
      Lease: FOR LEASE
      Ongoing:
        # What is displayed on the first line of the sign once someone
          # rents a claim.
        Rent: '[Rented]'
      # What is displayed on the third line of the sign when
        # renting container access only.
      ContainerRent: �9Containers only
  Rules:
    # Is selling claims enabled?
    Sell: true
    # Is renting claims enabled?
    Rent: true
    # Is leasing claims enabled?
    Lease: true
    # Can players renting claims enable automatic renew of their
      # contracts?
    AutomaticRenew: true
    # Can a rent contract last multiple periods?
    RentPeriods: true
    DestroySigns:
      # Should the rent signs get destroyed once the claim is rented?
      Rent: false
      # Should the lease signs get destroyed once the claim is leased?
      Lease: true
    # Are the claim blocks transfered to the new owner
      # on purchase or should the buyer provide them?
    TransferClaimBlocks: true
    # Should the signs display the prices with a currency
      # symbol instead of the full currency name?
    UseCurrencySymbol: false
    # In case UseCurrencySymbol is true, what symbol should
      # be used?
    CurrencySymbol: $
    # Allow players to use decimal currency e.g. $10.15
    UseDecimalCurrency: true
  Messaging:
    # Should the owner get messaged once one of his claim is rented/leased/bought
      # and on end of contracts?
    MessageOwner: true
    # Should the buyer get messaged once one of his claim is rented/leased/bought
      # and on end of contracts?
    MessageBuyer: true
    # Should a message get broadcasted when a player put a claim
      # for rent/lease/sell?
    BroadcastSell: true
    # Should offline owner/buyers receive mails (using the Essentials
      # plugin) when they're offline?
    MailOffline: true
  Default:
    PricesPerBlock:
      # Chat is the default price per block when selling a claim
      Sell: 5.0
      # Chat is the default price per block when renting a claim
      Rent: 2.0
      # Chat is the default price per block when leasing a claim
      Lease: 2.0
    Duration:
      # How long is a rent period by default
      Rent: 7D
      # How long is a lease period by default
      Lease: 7D
    # How many lease periods are required before the buyer
      # gets the claim's ownership by default
    LeasePaymentsCount: 5
  Settings:
    # How many Real Estate offer should be shown by page using the
      # '/re list' command
    PageSize: 8
    # Language file to be used. You can see all languages files
      # in the languages directory. If the language file does not exist, it will be
      # created and you'll be able to modify it later on.
    MessagesFiles: en.yml