Get 0.05 TON 💎Earlier Versions
| Name | Size | Uploaded | Game Version | Downloads | |
| Documenter 0.3 beta | 1.27 MB | Feb 23, 2016 | 1.8.1 | 167 |  Download |
| Documenter 0.2.3 beta | 1.15 MB | Feb 17, 2016 | 1.8.1 | 106 | Download |
| Documenter 0.2.2 beta | 2.74 MB | Feb 17, 2016 | 1.8.1 | 116 | Download |
Screenshots
Description
About
Documenter provides an alternative way of reading information about your plugins and their commands.
It formats the command list (as found in /help) to a fancy command documentation that can be
exported as .html, .png or directly uploaded to Imgur.
Setup
Installation
- Download the latest plugin jar file and place it into your plugins folder
- Restart or reload your server
If you want to save the documentation as a file:
- Set
imgur_upload.enabledtofalsein Documenter/config.yml - Set
html.enabledorimage.enabled(or both) totruein Documenter/config.yml - Use command
/documenter config reloadto reload your settings from config.yml
If you want to upload the documentation to Imgur:
- Create an account at Imgur if you don't already have one
- Create a new application with your Imgur account
- Replace the default value of
imgur_upload.application_client_idin Documenter/config.yml with your application client ID - Use command
/documenter config reloadto reload your settings from config.yml
Usage
Use command /documenter build and wait for output.
This will either save the documentation in the plugins/Documenter directory
or return an Imgur image link depending on your settings.
Commands
| Command | Alias | Permission | Usage |
|---|---|---|---|
| /documenter | /doc | documenter.command.info | Displays general information about the plugin |
| /documenter build | /doc build | documenter.command.build | Builds the server documentation (and saves / uploads it depending on your config.yml) |
| /documenter config reload | documenter.command.config.reload | Reloads configuration from config.yml |
Development
Documenter is currently in an early stage of development regarding user-friendliness and stability.
Please report bugs, typos and any weird behaviour.
MCStats
Documenter uses MCStats which sends some general server information
(including your Bukkit version, your Java version and your average player count)
to mcstats.org.
That information is strictly anonymous and publicly available.
Click here to see the Documenter statistics on MCStats.
If you want to disable this feature, include opt-out: true in plugins/PluginMetrics/config.yml.
Requirements
Java 8 or above (you should be using Java 8 or above anyways)
Screenshots
Ingame chat after using /documenter build
Built with Documenter 0.1 on a server with PermissionsEx, Vault and ProtocolLib
Add a comment