Extension.boardware

From Owl
Revision as of 12:36, 10 June 2014 by Admin (talk | contribs) (Valid Boardwares)

Jump to: navigation, search

Some extensions may require certain boardware versions in order to function. Extension writers can set requirements on the extensions by using the extension.boardware property. For example, the following line defines that the extension requires vBulletin with at least version 3.6 and up to but not including 4.0:

<source lang="lua">extension.boardware = "vbulletin/[3.6,4.0)";</source>

Valid Boardwares

Valid Boardware Settings
phpBB phpbb
Simple Machines Forum smf
Tapatalk tapatalk
vBulletin vbulletin
XenForo xenforo

Version Numbers & Version Ranges

To define a specific version number the number should be specified after the boardware code (as defined above) with a slash. For example, to define an extension that requires phpBB 1.2 (and 1.2 only) the version would be specified as:

<source lang="lua">extension.boardware = "phpbb/1.2";</source>

Defining a version range uses mathematic endpoint notation. For example, to define a version requirement of vBulletin versions greater than (but not including) 3.6 and up to (and including) 3.8 would be as follows:

<source lang="lua">extension.boardware = "vbulletin/(3.6,3.8]</source>

This does not include build or revision numbers. Hence, the versioning defined above does not include 3.8.1 since with software versioning 3.8.1 > 3.8. Alternatively, versioning can including build and revision numbers using wildcards:

<source lang="lua">extension.boardware = "vbulletin/(3.6,3.8.*]</source>

Hence, the extension will run with vBulletin 3.8.1, 3.8.2, etc, as well as 3.8.1.1, 3.8.1.2 and so on.

See also