Skip to content

thexaero/open-parties-and-claims

Repository files navigation

Open Parties and Claims

This Minecraft mod adds the ability to claim and to forceload world chunks, as well as create and manage player parties. It also gives server owners powerful controls over their players' usage of the mod's features.

The mod's API allows other mods or plugins to easily interact with the parties and the chunk claims, both on the server and the client side.

The mod is currently in beta.

Dependencies

When using Fabric or Quilt, this mod depends on the Fabric API (or the Quilted Fabric API) and the Forge Config API Port.

User Guide

Playing

Get this mod from CurseForge. It is also recommended to get the Xaero's Minimap and the World Map mods, which implement this mod's API. Install this mod how you normally would a Forge/Fabric mod. There are plenty of tutorials online, if you're new.

Commands:

/openpac player-config ... - player config commands

/openpac-claims ... - everything claim-related

/openpac-parties ... - everything party-related

/opm - shortcut for the party chat

Keybindings:

' - open the mod UI. Can be changed in the controls menu.

Configs:

[world directory]/serverconfig/openpartiesandclaims-server.toml - the main mod config

[world directory]/serverconfig/openpartiesandclaims-... - some global "player configs", although all of them can be accessed in game through the UI

Developing

The license that this mod is released under, as I understand it, explicitly allows you have this mod as a dependency for your own mod and use the API through Java/JVM mechanics, under some conditions in some cases, mostly when embedding the mod in yours. That is why I chose it. It is very similar to what Minecraft Forge is currently released under. This paragraph is not a legal statement or legal advice. Make sure to get familiar with the actual license terms on your own.

Add this project as a dependency to your build.gradle, for example with CurseMaven or manually download a jar file from CurseForge and use a flatDir repository. Build the mod jar from the source code yourself if you so prefer.

I strongly recommend that you use the javadoc for reference when working with the API. Locate either or both of the following 2 main API classes in the javadoc and you should be good to go from there:

xaero.pac.client.api.OpenPACClientAPI

xaero.pac.common.server.api.OpenPACServerAPI

Contributions

I do not accept pull-requests at the moment, in case I decide to release this mod under a different license in the near future. Contributions from other people might cause complications.

MultiLoader Template

This project uses a multi-loader template from jaredlll08/MultiLoader-Template

About

Minecraft mod that adds chunk claims and player parties

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published