Skip to content

Commit 5c77c8d

Browse files
committed
Extend plugin docs in README.md
1 parent e5d39e6 commit 5c77c8d

File tree

1 file changed

+49
-6
lines changed

1 file changed

+49
-6
lines changed

README.md

Lines changed: 49 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,55 @@ how to create one yourself.
3030
The framework has support for plugins adding some functionality. They are in
3131
the `lua/themepark/plugins` directory.
3232

33-
Available plugins are:
34-
* `taginfo`: For creating [Taginfo project files]().
35-
* `tilekiln`: For creating a config file for the
36-
[Tilekiln](https://github.com/pnorman/tilekiln) tile server.
37-
* `t-rex`: For creating a config file for the
38-
[T-Rex](https://t-rex.tileserver.ch/) tile server.
33+
Available plugins are `taginfo`, `tilekiln`, and `t-rex`.
34+
35+
### Plugin `taginfo`
36+
37+
For creating [Taginfo project
38+
files](https://wiki.openstreetmap.org/wiki/Taginfo/Projects). The generated
39+
files are incomplete, they are intended as starting point only.
40+
41+
### Plugin `tilekiln`
42+
43+
For creating a config file for the
44+
[Tilekiln](https://github.com/pnorman/tilekiln) tile server.
45+
46+
Call like this from your config file to create a config in the `tk` directory
47+
(the directory must exist):
48+
49+
```
50+
themepark:plugin('tilekiln'):write_config('tk')
51+
```
52+
53+
A second argument on the `write_config()` function can contain a Lua table
54+
with options. Available options are:
55+
56+
* `tileset`: Name of the tileset, defaults to `osm`.
57+
* `attribution`: Set attribution string, defaults to the setting from the
58+
themepark config file.
59+
60+
### Plugin `t-rex`
61+
62+
This plugin can be used to create a config file for the
63+
[T-Rex](https://t-rex.tileserver.ch/) tile server.
64+
65+
You need the Lua `toml` module installed for this plugin.
66+
67+
Call like this from your config file to create a file called
68+
`t-rex-config.toml`:
69+
70+
```
71+
themepark:plugin('t-rex'):write_config('t-rex-config.toml')
72+
```
73+
74+
A second argument on the `write_config()` function can contain a Lua table
75+
with options. Available options are:
76+
77+
* `tileset`: Name of the tileset, defaults to `osm`.
78+
* `attribution`: Set attribution string, defaults to the setting from the
79+
themepark config file.
80+
* `extra_layers`: Extra layers that should be added to the config file. Use
81+
the same structure as the T-Rex config file would use.
3982

4083
## Themes
4184

0 commit comments

Comments
 (0)