https://osm2pgsql.org/themepark/
THIS IS BETA SOFTWARE. EVERYTHING IN HERE IS SUBJECT TO CHANGE.
This is a framework for creating osm2pgsql configurations assembled from many building blocks. Some of those blocks are provided in this repository, others you can add yourself. This way you don't have to start with a new configuration from scratch every time you build and style a new map. Instead you take those existing blocks that suit your needs and add new ones for those things that make your map special.
This framework makes use of the flex output and it needs at least version 1.9.2 of osm2pgsql. See the osm2pgsql installation documentation for how to install osm2pgsql.
When running osm2pgsql you'll always need the command line parameters -O flex -S CONFIG.lua. CONFIG.lua is the configuration file you are writing that
makes use of this framework. Some example config files are provided in the
config directory. Read the User
Manual for instructions on
how to create one yourself.
The framework has support for plugins adding some functionality. They are in
the lua/themepark/plugins directory.
Available plugins are taginfo, tilekiln, t-rex and bbox.
For creating Taginfo project files. The generated files are incomplete, they are intended as starting point only.
For creating a config file for the Tilekiln tile server.
Call like this from your config file to create a config in the tk directory
(the directory must exist):
themepark:plugin('tilekiln'):write_config('tk')
A second argument on the write_config() function can contain a Lua table
with options. Available options are:
tileset: Name of the tileset, defaults toosm.attribution: Set attribution string, defaults to the setting from the themepark config file.
This plugin can be used to create a config file for the T-Rex tile server.
You need the Lua toml module installed for this plugin.
Call like this from your config file to create a file called
t-rex-config.toml:
themepark:plugin('t-rex'):write_config('t-rex-config.toml')
A second argument on the write_config() function can contain a Lua table
with options. Available options are:
tileset: Name of the tileset, defaults toosm.attribution: Set attribution string, defaults to the setting from the themepark config file.extra_layers: Extra layers that should be added to the config file. Use the same structure as the T-Rex config file would use.
This plugin can be used to create a config file for the BBOX tile server.
Call like this from your config file to create a file called
bbox-config.toml:
themepark:plugin('bbox'):write_config('bbox-config.toml')
A second argument on the write_config() function can contain a Lua table
with options. Available options are:
tileset: Name of the tileset, defaults toosm.attribution: Set attribution string, defaults to the setting from the themepark config file.extra_layers: Extra layers that should be added to the config file. Use the same structure as the BBOX config file would use.
Themes provide building blocks for map data transformations. They usually contain some common code plus several topics; each topic usually provides the code to create one or more database tables which can then be used as a basis for a map layer.
You can write your own themes and topics, read the Authors Manual for details.
Several themes are available in this repository to get you going and support some common use cases.
This theme contains some basic layers for testing and debugging. It can also be used as a jumping-off point for your own theme creation.
The topics in this theme are not meant to be used on their own, but they provide common transformations which can be used with other themes and topics. This includes functionality for handling names.
These are some experimental layers. Use at your own risk.
This theme contains some layers not generated directly from OSM data but created from external sources, specifically data that can be downloaded from https://osmdata.openstreetmap.de/ .
Implements the Shortbread (v1.0) schema. Data for low zoom levels are not generated.
Implements the Shortbread (v1.0)
schema with automated
generalization for low zoom levels. This needs the experimental osm2pgsql-gen
command provided with newer osm2pgsql versions.
Some unit tests are provided in the tests directory. You'll nee the "busted"
testing framework installed (luarocks install busted or install the lua-busted apt package on Debian).
Run all tests:
bin/run-tests.sh
Copyright 2024 Jochen Topf jochen@topf.org
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This framework is written and maintained by Jochen Topf (jochen@topf.org).