Shopkeepers/README.md

51 lines
3.0 KiB
Markdown
Raw Permalink Normal View History

2017-10-20 03:08:15 -07:00
<p align="center">
<img src="https://github.com/Shopkeepers/Shopkeepers-Wiki/wiki/images/logos/shopkeepers_logo_small_with_text.png?raw=true" alt="Shopkeepers logo"/>
</p>
Shopkeepers [![Build Status](https://travis-ci.com/Shopkeepers/Shopkeepers.svg?branch=master)](https://travis-ci.com/Shopkeepers/Shopkeepers)
2013-12-02 09:01:27 -08:00
===========
2013-12-02 12:19:37 -08:00
Shopkeepers is a Bukkit plugin which allows you to set up custom villager shopkeepers that sell exactly what you want them to sell and for what price.
Added: It is possible to use barrels and shulker boxes as containers for player shops now. Also added a message (msg-unsupported-container) when a player tries to select a type of container which is not supported by shopkeepers (i.e. hopper, dropper, dispenser, brewing stand, ender chest, or a type of furnace). Other related changes: * API: Deprecated PlayerShopkeeper#getChestX/Y/Z, #get/setChest, #getCurrencyInChest, #openChestWindow and PlayerShopCreationData#getShopChest and added corresponding replacements methods with more general names. * Various internal renaming related to shop containers. * Various internal formatting of code comments. Config changes: * Changed a few comments inside the default config related to the shop container changes. * Bumped config version to '3'. A few settings were renamed which get automatically migrated: * `require-chest-recently-placed` (now `require-container-recently-placed`) * `max-chest-distance` (now `max-container-distance`) * `protect-chests` (now `protect-containers`) * `delete-shopkeeper-on-break-chest` (now `delete-shopkeeper-on-break-container`) * `enable-chest-option-on-player-shop` (now `enable-container-option-on-player-shop`) * `chest-item` (now `container-item`) Added messages: * msg-unsupported-container Changed messages: * Some message settings were renamed. If you don't use a custom / separate language file, they get automatically migrated as part of the config migration to version 3. However, most of these messages also had changes to their default contents which need to be applied manually. * msg-button-chest (now msg-button-container) * msg-button-chest-lore (now msg-button-container-lore) * msg-selected-chest (now msg-container-selected) * msg-must-select-chest (now msg-must-select-container) * msg-no-chest-selected (now msg-invalid-container) * msg-chest-too-far (now msg-container-too-far-away) * msg-chest-not-placed (now msg-container-not-placed) * msg-chest-already-in-use (now msg-container-already-in-use) * msg-no-chest-access (now msg-no-container-access) * msg-unused-chest (now msg-unused-container) * msg-cant-trade-with-shop-missing-chest (now msg-cant-trade-with-shop-missing-container) * msg-creation-item-selected * msg-shop-setup-desc-selling * msg-shop-setup-desc-buying * msg-shop-setup-desc-trading * msg-shop-setup-desc-book * msg-trade-setup-desc-selling * msg-trade-setup-desc-buying * msg-trade-setup-desc-book
2020-07-29 16:50:22 -07:00
You can set up admin shops, which have infinite supply, and you can also set up player shops, which pull supply from a container.
2013-12-02 12:19:37 -08:00
2019-05-29 02:07:15 -07:00
**BukkitDev Page**: https://dev.bukkit.org/projects/shopkeepers
2017-10-20 02:27:47 -07:00
**Wiki**: https://github.com/Shopkeepers/Shopkeepers-Wiki/wiki
2019-09-22 16:19:04 -07:00
**Translations** : https://github.com/Shopkeepers/Translations/
2017-10-20 02:27:47 -07:00
**Issue Tracker**: https://github.com/Shopkeepers/Shopkeepers/issues
2019-08-01 12:49:19 -07:00
**Discord Server**: https://discord.gg/d9NKd5z
**Source code**: https://github.com/Shopkeepers/Shopkeepers/
2017-10-20 02:27:47 -07:00
2019-05-29 02:07:15 -07:00
Maven repository for releases: https://nexus.lichtspiele.org/repository/releases/
Maven repository for dev builds (snapshots): https://nexus.lichtspiele.org/repository/snapshots/
2013-12-02 12:19:37 -08:00
2020-08-31 15:44:00 -07:00
If the above Maven repository is not available, you can also use Jitpack: https://jitpack.io/#Shopkeepers/Shopkeepers/
2020-08-31 15:43:04 -07:00
Maven Jitpack snapshots: https://jitpack.io/#Shopkeepers/Shopkeepers/master-SNAPSHOT
2017-10-23 07:39:13 -07:00
Pull Requests & Contributing
2013-12-02 12:19:37 -08:00
----------
2017-10-23 07:39:13 -07:00
See [Contributing](CONTRIBUTING.md)
2013-12-02 12:19:37 -08:00
2013-12-05 15:37:26 -08:00
Build with Maven
----------------
2020-08-31 15:23:07 -07:00
This is the recommended and easy way to compile the plugin yourself and/or help to contribute to it.
Just check out the project to your machine and import it in Eclipse with **Import > Maven > Existing Maven Project**.
Then make sure that you have all Spigot and CraftBukkit dependencies installed in your local Maven repository. The simplest way to do this is to run the included **./installSpigotDependencies.sh** script.
2020-08-31 15:11:35 -07:00
Afterwards just right click the imported project and select **Run As > Maven install**.
2013-12-05 15:37:26 -08:00
Build without Maven
-------------------
2017-10-20 03:14:29 -07:00
If you really want to do it the old school way, you're free to import the project in Eclipse with **Import > General > Existing Project into Workspace**. You'll find that the project will instantly show some errors because it's missing its dependencies. You also need to make sure that you'll include the provided modules (NMSHandlers).
**Here's how you do that:**
2017-10-20 03:14:29 -07:00
* After importing the project right click on it and select **Properties**
* Under **Java Build Path > Source** click on **Add Folder...** and add all provided modules:
2013-12-05 15:37:26 -08:00
* modules/v1_6_R3/src/main/java
* modules/v1_7_R1/src/main/java
* ...
2020-08-31 15:11:35 -07:00
* Under **Java Build Path > Library** click on **Add External JARs...** and add the needed Spigot.jar files for the modules above. Information on how to get them: https://www.spigotmc.org/wiki/spigot/
2018-06-01 16:24:49 -07:00
* After that you can create the plugin for example by right-clicking the project and selecting **Export > Java > JAR file** or another recommended way.
2013-12-05 15:37:26 -08:00