Bring [Geocaching](https://www.geocaching.com) to your Minecraft server!
This plugin allows players to hide and find Minecaches (or "Caches") around the server while allowing operators to manage it.
> DEVELOPERS: After v0.3.1.0, the artifact id is now `minecaching`, not `Minecaching`!
> DEVELOPERS: **Some API stuff has moved to a new plugin, RDSCommons!**
>
> RDSCommons is a new plugin for shared code across Minecaching and future plugins.
> See `For Developers / Transferring To RDSCommons` for more information!
## For Server Owners:
### Installation
You can find the latest version of Minecaching [here](https://modrinth.com/project/minecaching/).
**Minecaching also requires a dependency plugin, RDSCommons, which you can find [here](https://modrinth.com/project/rdscommons/)**.
Server owners can control many things, such as restrictions on where the caches are placed, the types of allowed caches, and more in the config!
Operators have access to certain commands, such as `/verify` and can (by default) bypass `/delete` and `/edit` checks.
For non-english servers, you should change the language in `pluginsMinecachingconfig.yml`.
In there you can also find many other options, such as changing the `/mcstats` scoring, configuring auto-updates, and more.
You can also change some config values in-game by using `/mca conf`
### Permission Nodes
| Permission Node |
Who has it by default? |
| minecaching.* |
Nobody |
| minecaching.bypass.* |
OP |
| minecaching.bypass.delete_others |
OP |
| minecaching.bypass.edit_others |
OP |
| minecaching.admin.* |
OP |
| minecaching.admin.* |
OP |
| minecaching.admin.config |
OP |
| minecaching.admin.force_stat_update |
OP |
| minecaching.admin.reload |
OP |
| minecaching.admin.server_data |
OP |
| minecaching.command.* |
OP |
| minecaching.command.admin |
OP |
| minecaching.command.archive |
OP |
| minecaching.command.create |
Everyone |
| minecaching.command.delete |
Everyone |
| minecaching.command.disable |
OP |
| minecaching.command.edit |
Everyone |
| minecaching.command.hint |
Everyone |
| minecaching.command.list |
Everyone |
| minecaching.command.locate |
Everyone |
| minecaching.command.log |
Everyone |
| minecaching.command.logbook |
Everyone |
| minecaching.command.maintainer |
Everyone |
| minecaching.command.publish |
OP |
| minecaching.command.stats |
Everyone |
| minecaching.misc.* |
OP |
## For Developers:
You can use the [Digitalunderworlds Maven](https://maven.digitalunderworlds.com) to add Minecaching to your project
Adding as a dependency
#### Snapshots:
```xml
dumaven-snapshots
Digitalunderworlds Maven Snapshots
https://maven.digitalunderworlds.com/snapshots
```
#### Releases:
```xml
dumaven-releases
Digitalunderworlds Maven Releases
https://maven.digitalunderworlds.com/releases
```
Then,
```xml
net.realdarkstudios
minecaching
0.4.0.0-snapshot-24w13a
```
You can view versions [here](https://maven.digitalunderworlds.com/#/snapshots/net/realdarkstudios/minecaching)
> NOTE: Only full version releases (such as 0.2.0.7) are available in the Releases maven.
> If you want to be able to use ANY version, including releases, pick the Snapshot repository!
Transferring to RDSCommons
With 0.4.0.0, a new plugin (RDSCommons) was created to hold shared code for Minecaching and future projects.
To start using RDSCommons, you will need to update to version Snapshot 24w13a or above.
Then, add this dependency, replacing (version) with the minimum version you require:
```xml
net.realdarkstudios
rdscommons
[(version), 1.0.99999.0)
provided
```
#### Changes Summary:
- PACKAGE net.realdarkstudios.minecaching.api.menu.impl -> net.realdarkstudios.commons.menu
- minecaching.api.misc.AutoUpdater -> commons.util.AutoUpdater
- minecaching.api.misc.AutoUpdater.Version -> commons.util.Version
- minecaching.api.misc.Localization -> commons.util.Localization
- minecaching.api.misc.LocalizationProvider -> commons.util.LocalizationProvider
- minecaching.api.util.LocalizedMessages -> commons.util.LocalizedMessages
- minecaching.api.util.TextComponentBuilder -> commons.util.TextComponentBuilder
- minecaching.api.util.MessagesKeys -> minecaching.api.util.MCMessageKeys (some keys are instead in commons.util.MessageKeys)
**Registering A Localization**:
```java
import net.realdarkstudios.minecaching.api.Minecaching;
import net.realdarkstudios.minecaching.api.MinecachingAPI;
import net.realdarkstudios.minecaching.api.misc.Config;
// OLD IMPORTS
import net.realdarkstudios.minecaching.api.misc.LocalizationProvider;
import net.realdarkstudios.minecaching.api.misc.Localization;
// NEW IMPORTS
import net.realdarkstudios.commons.CommonsAPI;
import net.realdarkstudios.commons.util.LocalizationProvider;
import net.realdarkstudios.commons.util.Localization;
@Override
public void onEnable() {
Localization exampleLocalization;
// OLD
exampleLocalization = MinecachingAPI.getLocalizationProvider().load(Minecaching.getInstance());
// NEW
exampleLocalization = CommonsAPI.get().registerLocalization(Minecaching.getInstance(), Config.getInstance().getServerLocale());
}
```
`MCMessages` was also removed. Please switch over to `LocalizedMessages`.
You may also implement `IRDSPlugin` in your main plugin class to be compliant for any plugin requesting your `Version` information
You can see the full changelog message below:
Snapshot 24w13a Changelog
Added:
- MAVEN SOURCES + JAVADOCS to (hopefully) all future Minecaching releases
- MCMessageKeys.Command.Stats.NONE
- MinecachingAPI#getCommonsAPI
Removed:
- MinecachingAPI#getConfigDataVersion
- MinecachingAPI#getMinecacheDataVersion
- MinecachingAPI#getPlayerDataVersion
- MinecachingAPI#getLogbookDataVersion
- MinecachingAPI#tInfo(String, Object...)
- MinecachingAPI#tWarning(String, Object...)
- (ALL CLASSES BELOW ARE IN RDSCommons)
- AutoUpdater
- BaseEvent
- BooleanMenuItem
- CancellableBaseEvent
- CloseMenuItem
- ErrorMenuItem
- GoBackMenuItem
- Localization
- LocalizationProvider
- MCMenu
- MCMenuHolder
- MenuItem
- MenuItemClickEvent
- MenuItemState
- MultiStateMenuItem
- PaginationMenu
- PaginationMenuItem
- PaginationPageItem
- RefreshPaginationMenuItem
- SkullMenuItem
- TextComponentBuilder
Refactors:
- MessageKeys -> MCMessageKeys
Changes:
- (BUGFIX) Added checks if there are 0 caches (caused issues with adding caches and stats)
- Switched over to RDSCommons
- UUID check is now in PlayerDataObject#update
- RDSCommons dependency
- MinecachingAPI#getLogger now returns an RDSLogHelper
- And more
88
