mod-pbmarks/README.md

## Personal Bookmarks

<img src="icon.png" alt="icon" width="100px" />

### Description:

A [Minetest][] mod that allows players to create a limited number of personal bookmarks to where they can teleport.

![screenshot](screenshot.png)

### Licensing:

- Code: [MIT](LICENSE.txt)
- Textures: CC0
- Icon: [CC0](https://openclipart.org/detail/266815)

### Usage:

```
- open formspec
	- sfinv:
		- select "More" tab
		- select "Personal Bookmarks"
	- unified_inventory & i3:
		- select "Personal Bookmarks" tab
	- chat command:
		- /pbmarks
- input a description into text field
- press "Set" to store location
- press "Go" to teleport to location
```

#### Settings:

```
- pbmarks.max
  - number of allowed bookmarks
  - type:    int
  - min:     1
  - max:     5
  - default: 5

- pbmarks.disallow_protected
  - don't allow bookmarks to be set in areas not accessible to player (requires protection mod, currently only simple_protection supported)
  - type:    bool
  - default: true
```

### Requirements:

- Depends: [wdata](https://content.minetest.net/packages/AntumDeluge/wdata/)
- Optional depends: [sfinv_buttons](https://content.minetest.net/packages/Wuzzy/sfinv_buttons/), [unified_inventory](https://content.minetest.net/packages/RealBadAngel/unified_inventory/), [i3](https://content.minetest.net/packages/jp/i3/), [simple_protection](https://content.minetest.net/packages/Krock/simple_protection/)

### Links:

- [![ContentDB](https://content.minetest.net/packages/AntumDeluge/pbmarks/shields/title/)](https://content.minetest.net/packages/AntumDeluge/pbmarks/)
- [Forum](https://forum.minetest.net/viewtopic.php?t=26805)
- [Git repo](https://github.com/AntumMT/mod-pbmarks)
- [API](https://antummt.github.io/mod-pbmarks/docs/api.html)
- [Changelog](changelog.txt)
- [TODO](TODO.txt)


[Minetest]: http://minetest.net/