Skip to content

Commit

Permalink
Rebranded to VaultUnlocked because accepting PRs and adding actual im…
Browse files Browse the repository at this point in the history
…provements is such a radical idea.
  • Loading branch information
creatorfromhell committed Jun 12, 2024
1 parent 8bad2c4 commit c491a54
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 110 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ jobs:
run: mkdir staging && cp target/*.jar staging
- uses: actions/upload-artifact@v2
with:
name: VaultAPI
name: VaultUnlockedAPI
path: staging
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish VaultAPI to GitHub Packages
name: Publish VaultUnlockedAPI to GitHub Packages
on:
release:
types: [created]
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@
/.project
/.settings
/bin/
/.idea/
/VaultAPI.iml
36 changes: 0 additions & 36 deletions .mvn/settings.xml

This file was deleted.

13 changes: 0 additions & 13 deletions .travis.yml

This file was deleted.

24 changes: 0 additions & 24 deletions .utility/do-publish.sh

This file was deleted.

9 changes: 0 additions & 9 deletions .utility/settings.xml

This file was deleted.

12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# VaultAPI - Abstraction Library API for Bukkit Plugins - [![](https://travis-ci.org/MilkBowl/VaultAPI.svg?branch=master)](https://travis-ci.org/MilkBowl/VaultAPI)
# VaultUnlockedAPI - Abstraction Library API for Bukkit Plugins - [![](https://travis-ci.org/MilkBowl/VaultAPI.svg?branch=master)](https://travis-ci.org/MilkBowl/VaultAPI)

How to include the API with Maven:
```xml
Expand Down Expand Up @@ -28,9 +28,11 @@ dependencies {
}
```

**Note**: The VaultAPI version has 2 numbers (major.minor), unlike Vault, which has 3. The 2 numbers in the VaultAPI will always correspond to the 2 beginning numbers in a Vault version to make it clear what versions your plugin will for sure work with.
**Note**: The VaultUnlockedAPI version has 2 numbers (major.minor), unlike Vault, which has 3. The 2
numbers in the VaultUnlockedAPI will always correspond to the 2 beginning numbers in a VaultUnlocked
version to make it clear what versions your plugin will for sure work with.

## Why Vault?
## Why VaultUnlocked?
I have no preference which library suits your plugin and development efforts
best. Really, I thought a central suite (rather...Vault) of solutions was the
the proper avenue than focusing on a single category of plugin. That's where
Expand Down Expand Up @@ -59,10 +61,10 @@ You should have received a copy of the GNU Lesser General Public License
along with Vault. If not, see <http://www.gnu.org/licenses/>.

## Building
VaultAPI comes with all libraries needed to build from the current branch.
VaultUnlockedAPI comes with all libraries needed to build from the current branch.

## Implementing Vault
Implementing Vault is quite simple. It requires getting the Economy, Permission, or Chat service from the Bukkit ServiceManager. See the example below:
Implementing VaultUnlocked is quite simple. It requires getting the Economy, Permission, or Chat service from the Bukkit ServiceManager. See the example below:

```java
package com.example.plugin;
Expand Down
56 changes: 35 additions & 21 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>net.milkbowl.vault</groupId>
<artifactId>VaultAPI</artifactId>
<version>1.7</version>
<artifactId>VaultUnlockedAPI</artifactId>
<version>2.0</version>

<name>VaultAPI</name>
<description>Vault is a Permissions &amp; Economy API to allow plugins to more easily hook into these systems without needing to hook each individual system themselves.
<name>VaultUnlockedAPI</name>
<description>VaultUnlocked is a Permissions &amp; Economy API to allow plugins to more easily hook into these systems without needing to hook each individual system themselves.

Vault currently supports the following: Permissions 3, PEX, GroupManager, bPerms, bPerms2, SimplyPerms, DroxPerms, zPermissions, rscPermissions, KPerms, Starburst, iConomy (4/5/6) BOSEconomy *6/7), EssentialsEcon, 3Co, MultiConomy, MineConomy, EconXP, eWallet, CurrencyCore, XPBank, CraftConomy, AEco, SDFEconomy, TAEcon
VaultUnlocked supports all plugins that support Vault
</description>
<url>http://dev.bukkit.org/server-mods/vault/</url>

Expand All @@ -18,25 +18,36 @@ Vault currently supports the following: Permissions 3, PEX, GroupManager, bPerms
</properties>

<!-- Organization -->

<organization>
<name>MilkBowl</name>
<url>https://github.com/MilkBowl</url>
<name>The New Economy</name>
<url>https://tnemc.net</url>
</organization>

<developers>
<developer>
<id>creatorfromhell</id>
<name>Daniel "creatorfromhell" Vidmar</name>
<email>[email protected]</email>
<url>https://cfh.dev</url>
<organization>The New Economy</organization>
<organizationUrl>https://tnemc.net</organizationUrl>
<roles>
<role>developer</role>
</roles>
<timezone>America/New_York</timezone>
</developer>
</developers>

<scm>
<url>https://github.com/MilkBowl/VaultAPI</url>
<connection>scm:git:git://github.com:MilkBowl/VaultAPI.git</connection>
<url>https://github.com/TheNewEconomy/VaultUnlockedAPI</url>
<connection>scm:git:git://github.com/TheNewEconomy/VaultUnlockedAPI.git</connection>
<developerConnection>scm:git:[email protected]:MilkBowl/VaultAPI.git</developerConnection>
</scm>

<ciManagement>
<system>Travis-CI</system>
<url>https://travis-ci.org/MilkBowl/VaultAPI</url>
</ciManagement>

<issueManagement>
<system>GitHub</system>
<url>https://github.com/MilkBowl/VaultAPI/issues</url>
<url>https://github.com/TheNewEconomy/VaultUnlockedAPI/issues</url>
</issueManagement>

<repositories>
Expand All @@ -47,11 +58,14 @@ Vault currently supports the following: Permissions 3, PEX, GroupManager, bPerms
</repositories>

<distributionManagement>
<repository>
<id>github</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/milkbowl/github-releases</url>
</repository>
<repository>
<id>codemc-releases</id>
<url>https://repo.codemc.io/repository/maven-releases/</url>
</repository>
<snapshotRepository>
<id>codemc-snapshots</id>
<url>https://repo.codemc.io/repository/maven-snapshots/</url>
</snapshotRepository>
</distributionManagement>

<dependencies>
Expand Down Expand Up @@ -110,7 +124,7 @@ Vault currently supports the following: Permissions 3, PEX, GroupManager, bPerms
<version>true</version>
<linksource>true</linksource>
<notimestamp>true</notimestamp>
<bottom><![CDATA[<b>Milkbowl, 2020</b>]]></bottom>
<bottom><![CDATA[<b>TheNewEconomy, 2024</b>]]></bottom>
<reportOutputDirectory>${project.build.directory}</reportOutputDirectory>
<destDir>javadoc-latest</destDir>
</configuration>
Expand Down

0 comments on commit c491a54

Please sign in to comment.