Factoids
Factoids is a documentation and help plugin for Bukkit. Provide predefined facts to your players and stop repeating yourself.
Factoids logo.
Description
Factoids is a documentation and help plugin for Bukkit. Provide predefined facts to your players and stop repeating yourself.
Factoids is still considered to be in beta. To my knowledge, it's both functional and stable, but it isn't exactly easy for the average server admin to use at this point. A few updates to change this will be on the way in the near future.
Features
- Provide documentation and help to your players in the form of short facts.
- Allow your moderators to send facts to your players to answer questions.
- Broadcast facts to everyone on your server as needed.
- Facts are stored in a MySQL database, but loaded into RAM on server start/reload for efficient retrieval.
- Designed with web access and cross-platform support in mind. A web app is provided to display your facts and search in real time (see below).
Requirements
- MySQL database (no flatfile support, sorry).
Other Info
- In the current version of this plugin, you must add facts directly to your database. If you do not know how to do this, this plugin (currently) isn't for you.
- There are currently no plans to add support for other forms of storage. However, that may change in the future.
Commands
| Command | Description | Alias |
|---|---|---|
| /fact <factID> | View a fact. | /?? |
| /fact <player> <factID> | Send a fact to a player. | /?? |
| /fact * <factID> | Send a fact to all online players. | /?? |
| /factoids <about/reload> | Factoids utility command. | /?f |
Permissions
| Permission | Description | Command |
|---|---|---|
| factoids.view | Allows viewing of facts. | /fact <factID> |
| factoids.send | Allows sending facts to others. | /fact <player> <factID> |
| factoids.broadcast | Allows broadcasting facts. | /fact * <factID> |
| factoids.util | Allows usage of the utility command. | /factoids |
| factoids.mods | Grants the view/send/broadcast permissions. | - |
| factoids.admins | Grants all Factoids permissions. | - |
Configuration
| Option | Type | Description |
|---|---|---|
| Debug | Boolean | If true, show debug messages in console. |
| MySQL.Host | String | The IP/hostname of your database. |
| MySQL.Database | String | The name of your database. |
| MySQL.Username | String | The user for your database. |
| MySQL.Password | String | The password for your database user. |
| Format.Factoid | String | Default format for fact text. |
| Format.Title | String | Default format for fact titles. |
| Format.Border | String | Default format for fact borders. |
| Presets.Default | String | Fact to show if no ID is provided. |
| Settings.ShowTitle | Boolean | If true, show the fact title by default. |
| Settings.ShowBorder | Boolean | If true, show the fact border by default. |
Database Entries
| Field | Type | Description |
|---|---|---|
| id | varchar(32) | The ID of the fact, used in commands. |
| title | varchar(64) | The title of the fact to display. If NULL, the ID is used as a title. |
| factoid | text | The text of the fact. New lines are represented by ;; and color codes are supported (using &). |
| showtitle | int(1) | If 1, the title is shown with the fact. If 0, it's not. If NULL, the default is used. |
| showframe | int(1) | If 1, the frame is shown with the fact. If 0, it's not. If NULL, the default is used. |
Planned
- Commands to allow adding/removing/editing facts in-game.
Source
Source is available on GitHub:
Web App
A simple web app is provided to display your list of facts on your website. It lists all of your facts and allows users to search/filter them in real time.
Setup instructions are included in the README.
Comments
If you have any questions, concerns, requests, or problems, feel free to comment.
The Factoids Team
