Commands & Permissions

Syntax

All commands starts with /abook <sub-command>.

Sub-Commands

Command	Permissions	Description
help [page]	astralbooks.command.help	Shows help page
security	astralbooks.command.security	Main security sub-command.
security list <*/player> [page]	astralbooks.command.security.list	List all books created by a player or all players.
security getbook <player> <timestamp>	astralbooks.command.security.getbook	Get the book a player has created.
npc	astralbooks.command.npc	Main npc sub-command.
npc set [right/left]	astralbooks.command.npc.set	Set a book to an NPC
npc remove [right/left]	astralbooks.command.npc.remove	Removes the book from an NPC
npc getbook [right/left]	astralbooks.command.npc.getbook	Gets the book from an NPC.
openbook	astralbooks.command.openbook	Makes a written book to be writable again.
closebook <author> <title>	astralbooks.command.closebook	Makes a writable book to be a written book.
reload	astralbooks.command.reload	Reloads the plugin.
setcmd <command> <filter name> [permission]	astralbooks.command.setcmd	Sets a new command that can be executed by players.
remcmd <command>	astralbooks.command.remcmd	Removes an command.
setjoin	astralbooks.command.setjoin	Sets the join book.
remjoin	astralbooks.command.remjoin	Removes the join book.
forceopen <filter name> <player>	astralbooks.command.forceopen	Forces one or more players to open a specific book.
filter	astralbooks.command.filter	Main filter sub-command.
filter set <filter name>	astralbooks.command.filter.set	Sets an filter book.
filter remove <filter name	astralbooks.command.filter.remove	Removes an filter book.
filter getbook <filter name	astralbooks.command.filter.getbook	Gets the book from an filter.
filter list [page]	astralbooks.command.filter.list	Shows all filter books.
actionitem or ai	astralbooks.command.actionitem	Main actionitem sub-command.
ai set <filter name> [right/left]	astralbooks.command.actionitem.set	Puts a filter book on the item you hold.
ai remove [right/left]	astralbooks.command.actionitem.remove	Removes the filter from the item you hold.
interaction	astralbooks.command.interaction	Main interaction sub-command.
interaction set	astralbooks.command.interaction.set	Main interaction set sub-command.
interaction set block [right/left]	astralbooks.command.interaction.set.block	Apply a book on a block.
interaction set entity [right/left]	astralbooks.command.interaction.set.entity	Apply a book on an entity.
interaction remove	astralbooks.command.interaction.remove	Main interaction remove sub-command.
interaction remove block [right/left]	astralbooks.command.interaction.remove.block	Remove a book from a block.
interaction remove entity [right/left]	astralbooks.command.interaction.remove.entity	Remove a book from an entity.

[variable] means it's an optional variable <variable> means it's an required variable

Outside Permissions

Permissions	Description
astralbooks.nojoinbook	Players that have this permission won't receive the join book.
astralbooks.notify	Players that have this permission will receive a message if an update is found.

Console Only

Import

To import from the old CitizensBooks plugin, install both CitizensBooks and AstralBooks, then use abook import citizensbooks in the console. You can remove CitizensBooks after is done.

Convert

To convert from one type of database to another, setup both databases in the settings, then use abook convert <mysql/sqlite/json/h2> in the console.

Example: if you enabled mysql but you previously had json, you should use abook convert json to convert json to mysql.