Skip to content
/ MyWarp Public
forked from mung3r/MyWarp

An extension for Minecraft (Spigot API) that allows players to create and share warps.

License

Notifications You must be signed in to change notification settings

MyWarp/MyWarp

 
 

Repository files navigation

MyWarp

MyWarp is an extension for Minecraft (Spigot API) that allows players to create and share warps. It is highly customizable, fully localized and supports economy plugins.

Build Status Crowdin Latest Release Downloads on BukkitDev License

Features

  • Create public and private warps.
  • Invite players or whole permission groups to warps.
  • Use buttons or pressure plates to teleport to warps.
  • Limit the number of warps players can create via permissions.
  • Charge users for creating or using warps (via Vault).
  • Use cooldowns and warmups for warps.
  • Translate or change every message that your players might see.
  • Store warps in an SQL-Database (H2, SQLite, MySQL).
  • Supports every Bukkit version from 1.7.10 to current.

Installation & Usage

Download the latest release from GitHub. Place the jar file in your server's plugins folder and restart the server. MyWarp will generate all necessary files and you can start creating and using warps. Check the documentation for information on permissions and other options.

Getting Help

Please check the documentation for information on how to use and configure MyWarp. If you have a question or encounter an issue, please open an issue.

Contributing

At this point, MyWarp is considered feature complete. We are still open for PRs, but you may want to open an issue first to discuss any changes. See CONTRIBUTING for guidelines to follow, as well as some comments on the project's structure.

Build

MyWarp is built using Gradle, targeting Java 8. To compile, clone this repository and run:

gradlew build

Publishing Artifacts

Build artefacts can be published on mywarp.github.io/builds using the gitPublishPush task. This requires access to the repo of the website. Additionally, the build number has to be set in order for the build to be displayed correctly.

For the master branch, the publication is handled automatically by the CI.

Customizing the Build

The build can be customized via environment variables or project properties (-Pkey=value):

Key Value
BUILD_NUMBER The number of the build relative to the current system.
CI_SYSTEM The name of the CI system that runs the build.
COMMIT_HASH The short hash of the current commit. If not set, the build process attempts to resolve this automatically.
CROWDIN_KEY Crowdin's API key. If present, translations will be downloaded from crowdin and shaded into the JAR.
GRGIT_USER A GitHub token that provides access to the repository artefacts are published in. To set via project property, use org.ajoberstar.grgit.auth.username as key.

License

MyWarp is available under GPL3.