Release 0.3.0

.github/workflows/build.yml

@@ -0,0 +1,38 @@
+name: SonarCloud
+on:
+  push:
+    branches:
+      - develop
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  build:
+    name: Build and analyze
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'zulu' # Alternative distribution options are available.
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Build and analyze
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BentoBoxWorld_Upgrades

.gitignore

@@ -1,31 +1,87 @@
-# Compiled class file
-*.class
+ # Git
+*.orig
+!.gitignore
+/.settings/        
+
+ # Windows
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+*.stackdump
+[Dd]esktop.ini
+$RECYCLE.BIN/
+*.lnk
 
-# Log file
-*.log
+ # Linux
+*~
+.fuse_hidden*
+.directory
+.Trash-*
+.nfs*
 
-# BlueJ files
-*.ctxt
+ # MacOS
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
 
-# Mobile Tools for Java (J2ME)
+ # Java
+*.class
+*.log
+*.ctxt
 .mtj.tmp/
-
-# Package Files #
 *.jar
 *.war
 *.nar
 *.ear
-*.zip
-*.tar.gz
-*.rar
-
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
-/target/
-/.settings/
-/.classpath
-/.project
-/dependency-reduced-pom.xml
-/.DS_Store
-/MagicCobblestoneGenerator.iml
-/bin
+
+ # Maven
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+
+ # Intellij
+*.iml
+*.java___jb_tmp___
+.idea/*
+*.ipr
+*.iws
+/out/
+.idea_modules/
+
+ # Eclipse
+*.pydevproject
+.metadata
+.gradle
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.project
+.externalToolBuilders/
+*.launch
+.cproject
+.classpath
+.buildpath
+.target
+
+ # NetBeans
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+nbactions.xml
+nb-configuration.xml
+.nb-gradle/

README.md

@@ -1,23 +1,57 @@
-# Island Upgrades Addon
+Upgrades Addon
+==========
 [![Discord](https://img.shields.io/discord/272499714048524288.svg?logo=discord)](https://discord.bentobox.world)
+[![Build Status](https://ci.codemc.io/buildStatus/icon?job=BentoBoxWorld/Upgrades)](https://ci.codemc.io/job/BentoBoxWorld/job/Upgrades/)
 
-Add-on for BentoBox to provide a Upgrades to upgrade an island of any BentoBox GameMode.
+## About
+Add-on for BentoBox to provide Upgrades to an island of any BentoBox GameMode.
+
+By default, this addon includes upgrades for island size, limits and commands
+
+## Soft Dependence
+
+Upgrades addon can hook onto Vault as well as limits addon and level addon :
+* Without Vault, Money cost will be ignored.
+* Without Level addonn, Island level will be ignored
+* Without Limits addon, Limits upgrades will not be displayed
 
 ## Where to find
 
-Currently Island Upgrades Addon is in **Early Alpha stage**, so it may or may not contain bugs... a lot of bugs. Also it means, that some features are not working or implemented.
+Currently Upgrades Addon is in **Alpha stage**, so it may or may not contain bugs.
+
+You can download the last snapshot [here](https://ci.codemc.io/job/BentoBoxWorld/job/Upgrades/)
 
-If you like this addon but something is missing or is not working as you want, you can always submit an [Issue request](https://github.com/Guillaume-Lebegue/IslandUpgrades/issues)
+If you like this addon, but something is missing or is not working as you want, you can always submit an [Issue request](https://github.com/BentoBoxWorld/Upgrades/issues)
 
 ## How to use
 
-For now, you must download the repo and compile the .jar yourself
-Then add it to BentoBox Addons
+1. Download last snapshot [here](https://ci.codemc.io/job/BentoBoxWorld/job/Upgrades/).
+2. Then add it to BentoBox Addons.
+3. Restart the server.
+4. Edit the Config.yml how you want.
+5. Restart the server.
 
 ## Config.yml
 
 The config.yml has the following sections:
 
 * **Disabled GameModes** - specify Game Modes where islandUpgrades will not work.
-* **Range Upgrade Tiers** - ability to specify default Range upgrade tiers
-* **GameMode Range Upgrade Tiers** - ability to specify Range upgrade tiers for specific game mode.
+* **Range Upgrade Tiers** - specify default Range upgrade tiers. Upgrading this will augment island protection size
+* **Block Limits Upgrade Tier** - specify default Block Limits tiers. Upgrading this will augment the block limits of the limits addon
+* **Entity Limits Upgrade Tier** - specify default Entity Limits tiers. Upgrading this will augment the entity limits of the limits addon
+* **Entity Group Limits Upgrade Tier** - specify default Entity Group Limits tiers. Upgrading this will augment the entity group limits of the limits addon
+* **Command Upgrade Tier** - specify default Command Tiers. You can link command to this upgrade.
+* **GameMode** - ability to specify upgrade tiers for specific game mode.
+* **Entity Icon** - This list the icons for Entity Upgrades
+* **Entity Group Icon** - This list the icons for Entity Group Upgrades
+* **Command Icon** - This list the icons for Command Upgrades
+
+### Other Add-ons
+
+Upgrades is an add-on that uses the BentoBox API. Here are some other ones that you may be interested in:
+
+* [**Addons**](https://github.com/BentoBoxWorld/BentoBox/blob/develop/ADDON.md)
+
+Bugs and Feature requests
+=========================
+File bug and feature requests here: https://github.com/BentoBoxWorld/Upgrades/issues