Files
node-mbtiles/README.md
2011-05-19 18:04:07 -04:00

50 lines
1.1 KiB
Markdown

# mbtiles
Utilities and [tilelive][1] integration for the [MBTiles][2] format.
### Installation
npm install mbtiles
### Commandline tools
Several commandline tools are included in `bin` for manipulating existing
MBTiles files.
mbcheck [FILE]
Check an mbtiles for missing metadata and tiles.
mbcompact [FILE]
Eliminate duplicate images to reduce mbtiles filesize.
mbpipe [COMMAND] [FILE]
Pipe each tile to stdin of the specified command and
write stdout into the mbtiles file.
mbrekey [FILE]
Rekey a compacted mbtiles to save space.
### tilelive.js integration
Example of using `tilelive` to serve tiles from an `mbtiles` file.
var tilelive = new Server(require('mbtiles')),
tilelive.serve({
datasource: '/my/map.mbtiles',
x: 0,
y: 0,
z: 0,
format: 'png'
}, function(err, data) {
if (!err) throw Err
// data[0]: PNG image
// data[1]: HTTP headers object appropriate for PNG format
});
[1]: https://github.com/mapbox/tilelive.js
[2]: http://mbtiles.org