Skip to content

Commit

Permalink
Minor changes and updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
dscalzi committed Jul 11, 2017
1 parent 5bc296b commit a220fec
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,25 @@ The source and destination file paths are saved inside of the config.yml. This m
* Compression of any file into the **ZIP** format.
* Queueable operations if you have many extractions/compressions to perform.
* Configurable [Thread Pool Executor][thread_pools] allowing you to set a maximum queue size and maximum number of threads to run at once. Incase of an emergency the Thread Pool can be shutdown at anytime.
* Option to be warned if an extraction/compression would result in files being overriden.
* If enabled, users will require an additional permission in order to proceed with the process.
* For extractions, you can view every file which would be overriden prior to proceeding with the process.
* Metrics by [bStats][bStats]

You can find more extensive details on the [wiki][wiki].

***

#Contributing

If you would like to contribute to this project, feel free to submit a pull request. The project does not use a specific code style, but please keep to the conventions used throughout the code.

To build this project you will need maven. Clone this repo and run `mvn clean install`.

Since the main purpose of this plugin deals with archive extraction, the plugin uses a provider system so that new formats can be easily supported. If you need support for a specific file extension you can create an issue and request it or submit a pull request which adds the provider. The *BaseProvider* class is documented in the code and implementations already exist if you need examples. A reference to each provider is kept in the *ZExtractor* class.

***

#Links
* [Spigot Resource Page][spigot]
* [Dev Bukkit Page][devbukkit]
Expand Down
4 changes: 2 additions & 2 deletions src/com/dscalzi/zipextractor/MainExecutor.java
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ private void cmdExtract(CommandSender sender, String[] args){
}
} else {

boolean override = !cm.warnOnConflitcs();
boolean override = !cm.warnOnConflitcts();
if(args.length >= 2 && args[1].equalsIgnoreCase("-override")) {
if(!sender.hasPermission("zipextractor.admin.override.extract")){
mm.noPermission(sender);
Expand Down Expand Up @@ -202,7 +202,7 @@ private void cmdCompress(CommandSender sender, String[] args){
return;
}

boolean override = !cm.warnOnConflitcs();
boolean override = !cm.warnOnConflitcts();
if(args.length >= 2 && args[1].equalsIgnoreCase("-override")) {
if(!sender.hasPermission("zipextractor.admin.override.compress")){
mm.noPermission(sender);
Expand Down
2 changes: 1 addition & 1 deletion src/com/dscalzi/zipextractor/managers/ConfigManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ public boolean getLoggingProperty(){
return this.config.getBoolean("general_settings.log_files", false);
}

public boolean warnOnConflitcs() {
public boolean warnOnConflitcts() {
return this.config.getBoolean("general_settings.warn_on_conflicts", true);
}

Expand Down

0 comments on commit a220fec

Please sign in to comment.