From 8c47ae9b3cda162a29d35075af36dd4b4d4d7fed Mon Sep 17 00:00:00 2001 From: Thijs Wiefferink Date: Sun, 12 Aug 2018 16:41:03 +0200 Subject: [PATCH] Add README.md files in a couple of packages, closes #128 --- .../main/java/me/wiefferink/areashop/commands/README.md | 7 +++++++ .../src/main/java/me/wiefferink/areashop/events/README.md | 7 +++++++ .../main/java/me/wiefferink/areashop/features/README.md | 6 ++++++ .../src/main/java/me/wiefferink/areashop/regions/README.md | 7 +++++++ 4 files changed, 27 insertions(+) create mode 100644 AreaShop/src/main/java/me/wiefferink/areashop/commands/README.md create mode 100644 AreaShop/src/main/java/me/wiefferink/areashop/events/README.md create mode 100644 AreaShop/src/main/java/me/wiefferink/areashop/features/README.md create mode 100644 AreaShop/src/main/java/me/wiefferink/areashop/regions/README.md diff --git a/AreaShop/src/main/java/me/wiefferink/areashop/commands/README.md b/AreaShop/src/main/java/me/wiefferink/areashop/commands/README.md new file mode 100644 index 0000000..17e179d --- /dev/null +++ b/AreaShop/src/main/java/me/wiefferink/areashop/commands/README.md @@ -0,0 +1,7 @@ +# Commands + +This module contains all AreaShop commands. + +* `CommandAreaShop` is extended by all other classes, and implements some general functionality and defines which methods should be implemented. +* Other classes implement specific sub-commands, supply their help messages and tab completion. +* `CommandManager` class in the `managers` package handles incoming commands and dispatches them to the classes in this package. diff --git a/AreaShop/src/main/java/me/wiefferink/areashop/events/README.md b/AreaShop/src/main/java/me/wiefferink/areashop/events/README.md new file mode 100644 index 0000000..d880eca --- /dev/null +++ b/AreaShop/src/main/java/me/wiefferink/areashop/events/README.md @@ -0,0 +1,7 @@ +# Events + +This package contains event classes that allow other plugins to listen to events about AreaShop regions. + +* `RegionEvent` class represents a generic event. +* `CancellableRegionEvent` represents an event that has a region and can be cancelled. +* `NotifyRegionEvent` represents events that are to inform only, and cannot be cancelled anymore (an `CancellableRegionEvent` would be sent first). diff --git a/AreaShop/src/main/java/me/wiefferink/areashop/features/README.md b/AreaShop/src/main/java/me/wiefferink/areashop/features/README.md new file mode 100644 index 0000000..0a9126a --- /dev/null +++ b/AreaShop/src/main/java/me/wiefferink/areashop/features/README.md @@ -0,0 +1,6 @@ +# Features + +This package contains classes that represent a certain feature and implement it for all regions. + +* `RegionFeature` represents a single feature, for each implementing class one instance is created without an assigned region, to listen for events etc, and an instance per region is created on-demand to handle region specific things. +* More features will be moved from `GeneralRegion` to these kind of classes, to keep all code for a feature together and cleanup `GeneralRegion`. \ No newline at end of file diff --git a/AreaShop/src/main/java/me/wiefferink/areashop/regions/README.md b/AreaShop/src/main/java/me/wiefferink/areashop/regions/README.md new file mode 100644 index 0000000..640f6c7 --- /dev/null +++ b/AreaShop/src/main/java/me/wiefferink/areashop/regions/README.md @@ -0,0 +1,7 @@ +# Regions + +This package contains the `GeneralRegion` class which represents a region in AreaShop. Such a region is linked to a WorldGuard region and has its own configuration file at `/plugins/AreaShop/regions/.yml`. + +The `BuyRegion` and `RentRegion` classes represent buy and rental regions (mutually exclusive) and inherit from `GeneralRegion`. + +To group regions there is `RegionGroup`, which allows configuring settings for a lot of regions at once. \ No newline at end of file