This plugin is inactive. Currently uploaded to GitHub so that interested people can participate

(title edited 31.12.2015, content not checked)

Uploaded to GitHub to enable others to participate in the code. https://github.com/jonatan98/CustomBook-Bukkit

Introduction

Ever just wanted to make a custom book for your players to read (like the rules in a book) and couldn't find that simple plugin? Well... That's why I made this plugin. This is the first plugin I've ever put on BukkitDev and I know it's very simple. But I will add more features over time..

What does the plugin do?

This plugin allows you to make unlimited custom books which you can edit to your likings in the config. Than all players with permissions to /cb or /custombook can spawn the books using /custombook or /cb <book name>. Did I tell you that you can make unlimited different books!?! You can also have unlimited books given to players the first time they join!

To list all the commands you can perform do /cb, if a player doesn't have permission to /cb reload and /cb create they won't be displayed.

Commands & Permission

How to install

• Step 1: Download this plugin. You only need this plugin there are no other requirements. (However a Permissions plugin can be usefull as this plugin has permissions for all of the commands that it has.)
• Step 2: Put Custom Books (this plugin) into your plugin folder.
• Step 3: Edit the config.yml file after your likings
• Step 4: Reload or Restart your server.
• Step 5: ???
• Step 6: Profit!

Configurating the config.yml

Configurating the plugin is very easy. If you've installed the plugin correctly there should be a folder in your plugins folder called "Books". In this folder a file called config.yml is located. This is how the config looks like:

Books:
  Information:
    Title: /c/Server information
    Author: /bthe server
    Content:
      Page-1: Welcome to the server!
      Page-2: This book is made using the plugin, custom-book aka books which you can read more about using /cb info
    EnableMessage: false
    Message: You have been given a custom book
JoinBooks:
  '1':
    Title: /c/Welcome to our server!
    Author: jn1234
    Content:
      Page-1: This book is given using a plugin named custom books aka books
      Page-2: /1/S/2/e/3/c/4/o/5/n/6/d /7/p/8/a/9/g/a/e
    EnableMessage: false
    Message: You have been given a custom book
List:
  '1':
    Title: information
    Description: Awesome Custom Books plugin, www.bukkit.org/bukkit-plugins/custom-book/
PlayerList:
- RandomPlayerName2

List:

• name = What the name of the book should be in /b (the help) and what the command should be (/b <name>)
• description = What the description of the book should be in /b (the help)

Books & JoinBooks:

• title = the title of the book
• author= By whom do you want it to by signed
• content = This is what will be displayed in the book. You can add up to 500 pages! to add pages simply add another Page-3 after Page-1 and Page-2
• PlayerList = the list of players with registered joins on your server
• EnableMessage = set true to enable messages sent to players when recieving the book
• Message = the message sent to the players while recieving the book

The numbers which marks the join books is what we refere to the "id" to use in permission nodes

Changelog:

• First version 1.0, which has all of the above.
• Version 1.2 - there are now permissions (book.use.[book name])
• Version 1.3.1 - We now took away book.donation (it was an old permission node.. it did the same as books.user). And from now on we're going to update from 1.3.1 to 1.3.2, 1.3.3 ect.
• Version 1.3.2 - Color support added :)
• Version 1.4 - Added multiple books! You can now have 6 separate books, 5 of them with custom command name!
• Version 1.4 - Added /b reload to reload the config if you ahve done some changes
• Version 1.4.1 - 1 custom joining book added!
• Version 1.4.3 - Made the CB command so that /b and /book(s) don't interfere with other plugins (no new config is needed)
• Version 1.5 - Cleaned some code and redid some stuff.
• Version 1.6 - Unlimited books!
• Version 1.6.1 - Minor fixes

To do..

Future updates:

• 1) Command for giving the book to another player, and all online players [not done, low priority]
• 2) Able to sell books to players. [not done]
• 3) Make it so you can make a new page by typing something like &7 [not done]

Known Bugs

None! :) If you have any questions are suggestions please say so in the comments

Colors

You can make everything here colored, the title, the author, and all the pages!

The way you do so is by using the normal color codes (found here: http://minecraft.gamepedia.com/Formatting_codes ) Then you remove the § and add a / on each side, this means that dark red would be /4/

How do I make enters?

Currently we have no way to make enters unless you add enters :(

Info

The plugin may not always be updated such as fast as the description :( this is because the plugin file needs to be validated by a site moderator before it gets uploaded. To prevent confusion i will try to update the latest version name here.

Latest version: 1.6.1

I you have found any bugs or are having problems with our plugin please send xXjn1234Xx a message with the console log and all the plugin files (except for the jar :p)