Key Stone Plugin Suite
The Key Stone plugin suite offers a range of modular plugins designed to offer the utmost customisability for a server owner without sacrificing the all important interoperability of multiple plugins. The suite will offer many modules, from chat managing, spam guarding and kicking/banning modules to modules for economy, games and leaderboards!
Module Map
The plugin suite as it stands is constantly under evaluation, so if you have any ideas throw the author a PM or post a ticket!
The following tiered list is the so far proposed modules that the author intends to create:
- Core Module
- Chat Manager Module
- Chat Guard Sub-Module
- Chat Announcer Sub-Module
- Punisher Module
- Economy Module
- Business Sub-Module
- Games Module
- A collection of game modules
- Dynasty Module
- Native Americans vs. Pioneers Sub-Module
- Leaderboard Module
- Chat Manager Module
The following list is the so far proposed modules that the author is considering creating:
- Races Module
- Classes Module
- Enchanting Module
- Mechanics Module
- Siege Mechanics Module
The following are brief descriptions of each module to give a basic idea of what each module will be capable of.
Chat Manager Module
This module will provide chat managing functionality such as chat formatting, channels (private and public) and much more!
Chat Guard Sub-Module
This module will provide chat protection features such as anti-spam, anti-foul language. It will, with access to the punishment module, also punish repeat offenders in the manner described by the server manager in their config file!
As a sub-module of the Chat Manager module, it will require that module to run.
Chat Announcer Sub-Module
This module will provide announcing features such as periodic broadcasts, emergency announcements and more.
As a sub-module of the Chat Manager module, it will require that module to run.
Punisher Module
This module will provide punishment options such as bans, temporary bans/mutes, kicking, ban IP and more!
Economy Module
This module will provide an economy for the server. It will include features such as wallets, basic shops and basic salaries.
Business Sub-Module
This module will extend the Economy module greatly; it will provide features such as banks, loans, interest, businesses (with workers and owners), wages and more!
As a sub-module of the Economy module, it will require that module to run.
Games Module
This module will provide the basis for all specific games modules that will depend on it.
Dynasty Module
This module will provide features that allow for players to band together and fight for a common cause.
Native Americans vs. Pioneers Sub-Module
This module will provide an overlay for the Dynasty Module that gives it the theme of Native Americans and Pioneers. It will also add extra functionality that relates to the theme.
Leaderboard Module
This module will provide leaderboards that will give rankings for things relating to many of the modules in the Key Stone suite.
Races Module
This module will allow the server owner and specific sub-module to define and create custom races for the server.
Example: This could be used with the Native American's vs. Pioneers sub-module to create the two races and apply the unique characteristics of the two to players of each race.
Classes Module
This module will allow the server owner and specific sub-module to define and create custom classes for the server. It could be used in conjunction with the Races module to provide classes for specific races.
Example: This could be used with the Native American's vs. Pioneers sub-module and Races module to create classes for the two races and apply each class' features to players of that class.
Enchanting Module
This module will provide features that allow for more customisable enchanting.
Example: When used in conjunction with the Races and Classes modules for the Native American's vs. Pioneers sub-module, it could limit the enchanting capabilities of certain classes and enhance it for others. It could also require such things as sacrifices or specific blocks (i.e. altars) for enchantment to take place.
Mechanics Module
This module will allow the change features of the Minecraft experience such as mobs, the aggro system, combat and more to create a unique atmosphere on the server!
Siege Mechanics Module
This module will allow the modification of mechanics such as mining, digging, breaking and entering and more so that the PvP experience can be tailored to suit the server perfectly.
Note 1: While the author would very much like to see all these modules created, he does not have all the time in the world so some may be dropped as time passes. If you don't want to see this happen and have some (or a lot) of experience in Java and Bukkit plugin development, then please contact the author through PM!
Note 2: These descriptions are very brief, more detailed descriptions will be provided when each modules individual pages are created
Key Stone Core
The Key Stone Core plugin is the basis from which all modules in the Key Stone plugin suite sprout. It offers some basic functionality, and gives all plugins designed for the Key Stone suite a basis for their modularisation.
Key Features
Currently the Key Stone Core plugin has little in the way of features as the creation of the plugin suite is just under way. Another reason is that the Core module is aimed at offering some basic features for developing other modules rather than offering functionality to the server itself. Features that are under consideration or are going to be implemented will be displayed in the table below.
| Feature | Implementation Status | Description |
|---|---|---|
| Help Menu | To Be Implemented | A help menu for users to easily learn commands of the available modules |
| Buddy System | To Be Implemented | A buddy system for befriending, ignoring and becoming the enemy of other players on the server |
Commands and Permissions
The Core module will offer several commands for functionality and managing of the plugin suite, however the majority of commands will be provided by each of the extra modules designed for the Key Stone suite.
Commands that are available are shown below.
| Command | Permission | Example | Description |
|---|---|---|---|
| Basic Help | 'KeyStone.basic.help' | "/KeyStone help" | This provides a help menu consisting of all available commands and their usages for standard players. |
| Admin Help | 'KeyStone.admin.help' | "/KeyStone help" | This provides a help menu consisting of all available commands and their usages for admin players. |
| Reload | 'KeyStone.admin.reload' | "/KeyStone reload <module name>" | This reloads the plugin module defined in the command. |
Commands that are intended to be made available are shown below.
| Command | Permission | Example | Description |
|---|---|---|---|
| Set Config Value | 'KeyStone.admin.editconfig' | "KeyStone set <module name> <config value name> <new value>" | This will allow for any value to be changed within a config file pertaining to the defined module |
Configuration
This will be completed soon! The configuration files are just a little underdeveloped as it stands, so expect a tiny wait.
Note for Developers
Like the ambition of this plugin suite? Want to see it succeed? Contact the author with a PM and get onboard!
If you would rather just contribute without joining as a member of the plugin development team then have a look at the GitHub repositories below: