Add version information

master
Wuzzy 2014-10-16 18:17:36 +02:00
parent 3e041a64f3
commit 5bc86d3092
2 changed files with 15 additions and 1 deletions

8
API.md
View File

@ -2,6 +2,14 @@
The L-System Tree Utility provides a set of simple functions to mess around with the tree database, generate trees from saplings and more.
## Variables
The table `ltool.VERSION` exports version information. This mod uses [Semantic Versioning](http://semver.org/).
This information comes in handle if you need to do some compability work.
* `ltool.VERSION.STRING`: Full version as string
* `ltool.VERSION.MAJOR`: Major (=first) version number, as number
* `ltool.VERSION.MINOR`: Minor (=second) version number, as number
* `ltool.VERSION.PATCH`: Patch (=third) version number, as number
## Data structures
### `treedef`

View File

@ -1,5 +1,11 @@
ltool = {}
ltool.VERSION = {}
ltool.VERSION.MAJOR = 1
ltool.VERSION.MINOR = 0
ltool.VERSION.PATCH = 0
ltool.VERSION.STRING = "1.0.0"
ltool.playerinfos = {}
ltool.default_edit_fields = {
axiom="",
@ -386,7 +392,7 @@ function ltool.tab_help_intro()
"tablecolumns[text]"..
"tableoptions[background=#000000;highlight=#000000;border=false]"..
"table[-0.15,0.25;5.5,4.5;help_intro;"..
"You are using the L-System Tree Utility mod version 0.2.0,"..
string.format("You are using the L-System Tree Utility mod version %s.,", ltool.VERSION.STRING)..
","..
"The purpose of this mod is to aid with the creation of L-system trees.,"..
"With this mod you can create\\, save\\, manage and plant L-system trees.,"..