Configuration

[DOCUMENT UNDER REVISION]

(Present since admittance 0.3.4)

Changes with version 0.4.0 and above are not all reflected on this page, but will be added very soon. Most information is still valid, though.
Default configuration for 0.4.2: http://dev.bukkit.org/paste/4691/
For permission based access with 0.4.1: the perm-prefix will be set in front of the name extracted from the sign - You must set a special prefix and/or suffix, otherwise access will not work - to not check the suffix, set the suffix to '' (empty string), similar with the prefix. Thus you can reach to use something like *Moderator instead of [Moderator] for permission based access. Don't forget to give the players or groups the corresponding permission, preset would be admittance.group.<extracted-name>, i.e. admittance.group.Moderator for a line with [Moderator] - If you have trouble, ensure permissions.superperms is set to true, don't forget the dot in the end ("x.y.") if you use x.y.<extr.-name> , and do use lower case for the permissions parts that are parsed form signs (the sign may have capital letters, but they will be made lower-case for checking).
For toggle-once signs with 0.4.2: Check out the defualt configuration entry at admittance.toggle, it is enabled by default, but you need to set prefix and/or suffix, the preset suffix is '~' only if the default configuration is created (reload or startup without admittance.yml present), otherwise the prefix and suffix will be set to an empty string (''), so that toggle-once is effectivvely disabled - with the default suffix, you simply use "[admittance]~" instead of "[admittance]".

Admittance will create a default configuration file as given below.
To use all features, giving ops permission to place admittance-signs anywhere, it would not be necessary to change the configuration.
However if you use several plugins that admittance could work with (for instance Essentials and iConomy) but want a certain one to be used for the economy features, or if you want to disable a certain feature, then you would have to change some entries in the configuration.

To apply configuration changes you can issue the command '/admittance reload' (console: without '/'), which will load the configuration, apply it and recheck for compatible plugins. Other commands are found here: Features/Commands, yet there are only '/admittance enable' and '/admittance disable' for globallly enabling or disabling use of admittance signs.

[To be extended]
Rough configuration guide:

• Below i refer to entries in the configuration with "admittance.enabled" or similar as a shorter way to mention, these entries really have to be "admittance:" and then in the next line and indented: "enabled:", as shown in the default configuration below.
• Use the enabled flags to have certain features be enabled or disabled (true/false). The entry 'admittance.enabled' can be changed by commands (players/console).
  You can disable individual features with access flags like admittance.party for:
  • public
    Public access.
  • individual
    Restricted access for individual players (Also includes owner access for party or economy related syntax on signs. There might be an extra flag for that lateron, though.)..
  • party
    Party related features.
  • economy
    Economy related features.
• To make sure a certain compatible interface is loaded, you can use the include-plugins lists. If include entries are set then only plugins matching those will be considered.
• To make sure a certain compatible interface is NOT loaded, you can use the exclude-plugins lists. A plugin name matching an exclude entry will not be considered (dominant versus include).
• include/exclude: It is possible to define prefixes with XYZ* or suffixes with *XYZ - in general the case might be ignored, if no exact matches are found.
• The "mechanism.global.ticks" entry specifies the preset activation duratiion for the mechanisms (all: doors, levers, buttons). The unit is "ticks", i.e. 1/20 of a second. So 2 seconds switching time would be 40 ticks.
• cantrigger
  the entry "admittance.need-cantrigger" can be set to ensure, that the cantrigger-interfae must be set, otherwise placing signs with admittance syntax would be prevented. The entry cantrigger.enabled can be used to disable cantrigger checks in general (even if an interface is set for that).
• pop-signs
  You can set if signs should pop out of the ground if admittance is disabled or the cantrigger checks fail. In the latter case the sign would remain empty if set to false.
• oppermissions
  With this flag you can allow ops to place admittance-signs no matter what the settings for cantrigger etc. are.

Default configuration file as created automatically:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

admittance:
    enabled: true
    need-cantrigger: false
    individual:
        enabled: true
    oppermissions: true
    cantrigger:
        enabled: true
        exclude-plugins: []
        include-plugins: []
    economy:
        enabled: true
        exclude-plugins: []
        include-plugins: []
    mechanism:
        global:
            ticks: 23
    public:
        enabled: true
    party:
        enabled: true
        exclude-plugins: []
        include-plugins: []
    pop-signs:
        cantrigger: true
        admittance-disabled: false