Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/toxuin/griswold

Bukkit Plugin: NPC that can repair your stuff!
https://github.com/toxuin/griswold

bukkit hacktoberfest minecraft plugin

Last synced: 4 days ago
JSON representation

Bukkit Plugin: NPC that can repair your stuff!

Host: GitHub
URL: https://github.com/toxuin/griswold
Owner: toxuin
Created: 2012-05-02T15:28:50.000Z (almost 13 years ago)
Default Branch: master
Last Pushed: 2020-10-02T10:24:57.000Z (over 4 years ago)
Last Synced: 2025-01-20T19:53:52.865Z (11 days ago)
Topics: bukkit, hacktoberfest, minecraft, plugin
Language: Java
Homepage:
Size: 278 KB
Stars: 3
Watchers: 5
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

Griswold
=========

[![Build Status](https://travis-ci.org/toxuin/Griswold.png)](https://travis-ci.org/toxuin/Griswold)
[![Join the chat at https://gitter.im/toxuin/Griswold](https://badges.gitter.im/toxuin/Griswold.svg)](https://gitter.im/toxuin/Griswold?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Bukkit Plugin: NPCs now can repair and enchant your stuff! – Without any commands!

Show your stuff to blacksmith and he'll tell you how much he wants for the job. If you agree – just pass him the item. Users have no commands (because they don't need them)!

Simple!

## Features:

* Command-free native minecraft game experience.

* Multiworld support.

* [Citizens](https://www.spigotmc.org/resources/citizens.13811/) support.

* Mod items support!

* Repairing does not clear enchantments on enchanted items!

* Items that are fully repaired can be enchanted (optional)!

* Fully multilingual. There are english, [German](https://github.com/toxuin/Griswold/blob/master/de_DE.yml) and [Russian](https://github.com/toxuin/Griswold/blob/master/ru_RU.yml) out-of-the-box, but you can add more!

* All major economy systems supported. If [Vault](http://dev.bukkit.org/server-mods/vault/) supports something - than it'll work with Griswold.

* Lightweight!

## Roadmap:

* Making NPC to be other living thing other than villagers

* Extracting the treats of NPCs to separate classes so you can make combinations!

* Your suggestions

## Give author a dollar!

I started to develop for Minecraft more than two years from now and only did it in my spare time. I still don't have a legit Minecraft account. Having one would be helpfull to give support in-person on online-mode servers. So if you want me to come to your server or just want to say "Thanks, Tony!" – feel free to use the button below. I will buy myself a minecraft account from these money.

* [Give author a dollar](https://www.paypal.com/cgi-bin/webscr?business=3YDH29HLTFR7E&item_number=github&cmd=_xclick&currency_code=CAD&amount=1&item_name=Give%20Tony%20a%20dollar)

* [Give five](https://www.paypal.com/cgi-bin/webscr?business=3YDH29HLTFR7E&item_number=github&cmd=_xclick&currency_code=CAD&amount=1&item_name=Give%20Tony%20five%20bucks)

* [Buy him a Minecraft copy!](https://www.paypal.com/cgi-bin/webscr?business=3YDH29HLTFR7E&item_number=github&cmd=_xclick&currency_code=CAD&amount=1&item_name=A%20Minecraft%20copy%20for%20Tony)

## Permissions:

* **griswold.admin** - lets you create and remove repairmen

* **griswold.tools** - lets users talk to repairmen who repair their weapons and tools

* **griswold.armor** - lets users talk to repairmen who repair armors

* **griswold.enchant** - lets users to enchant their gear at repairmen

## Commands:

These commands are for administrative purposes, users don't need them.

* **/blacksmith create name** - creates new repairman. You can also specify more parameters: **/blacksmith create name type cost**. Name can be anything and will be displayed in chat when user talks to repairman. NPC types are described below. Cost is repairman's multiplier of cost – it can be greater than 1 to make prices higher or below 1 to make prices lower. Prices are rounded to 2 digits after comma.

* **/blacksmith list** - lists all the repairmen ever created

* **/blacksmith remove name** - removes a particular repairman

* **/blacksmith despawn** / **respawn** - despawns or respawns all repairmen. Config is not re-read, you have to use next command to reload config.

* **/blacksmith names** – toggles names above their heads.

* **/blacksmith sound name bukkit_sound_id** – sets the interaction sound for the repairman. Use standard bukkit Sound names (you can find those [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html)). You can set sound to "mute" to be silent.

* **/blacksmith reload** - reloads config, despawns and then respawns all the repairmen.

All commands require griswold.admin permission and fallbacks to OP if something bad happens.

/blacksmith command has an alias – /bsmith to avoid conflicts with other plugins.

## NPC Types:

When you use /blacksmith create command you can specify a type of NPC. Available types are:

* "**all**" – can repair everything and enchant repaired things.

* "**weapon**" or "**armor**" – can repair only one type of items, cannot enchant.

* "**both**" – can repair everything but cannot enchant.

* "**enchant**" – these guys are just enchanters and cannot repair things.

## Config:

All parameters are stored in config.yml and are reloadable without restarting the server (**/blacksmith reload**).

**Debug** is for debugging stuff and not usually useful if you don't know why you need it. Default is "**false**".

**Timeout** is for timeout of blacksmiths "remember" your item and are waiting for you to confirm the repair. Default is "**5000**" (5 sec).

**Language** is a name of language file (without .yml at the end) stored next to config.yml and containing all the text in preferred language. Default is "**en_US**".

**UseEnchantmentSystem** tells the plugin if he should allow spawning of enchant-type repairmen and allow all-type ones to add enchantments.

**PriceToAddEnchantment** sets the price to add one random set of enchantments. Default - 50.

**ClearOldEnchantments** says to repairmen whether they should blank the item before they enchant it or just add new enchantments to it. Default - true that means "yes, blank it".

**EnchantmentBonus** is a number of "virtual bookshelves" around blacksmith. Greater the number - cooler are enchantments. Default - 5.

**UseEnchantmentSystem** switches the whole enchantment routine on and off.

**ShowNames** – shows names over NPC heads.

**DuplicateFinder** – when a new NPC spawns it will check for possible duplicates that may be there because of server crash in the past. It is off by default, but you can set it to true if you have NPC duplicate issues.

**DuplicateFinderRadius** is a radius where plugin will search for duplicate NPCs. Smaller means slightly less work for server and probably little bit safer (won't delete wrong guys). You don't usually want it to be more than 10 blocks anyways.

You also can alternate price calculation by changing basic armor and tool prices and enchantment cost. Modify parameters **BasicArmorPrice**, **BasicToolPrice** and **BasicEnchantmentPrice**.

Prices are calculated like this: repairman cost parameter \* (basic item type cost + (basic enchantment price \* number of enchantments \* sum'd enchantment levels)).

This formula makes repairment of simple non-enchanted items quite cheap, items with 1-2 enchantments are at moderate cost and uber-enchanted items repairment cost a fortune.

If you want to change sound that NPC are making on interact – you can use ingame command or change it in the config part of the NPC.

All other config parameters are configurable in-game, so you don't have to bother about them. But if you want – they are quite self-explanatory.

### Citizens integration

You can add traits to your npcs to act like respective Griswold NPC types.

Following traits can be added:
- griswold_tools
- griswold_armor
- griswold_both
- griswold_enchant
- griswold_all

Please don't add multiple traits at once, lol.

### How to add a custom item

You have to create a new entry in config with name CustomItems. This entry will contain two more entries: Tools and Armor. Under those you add your items in "'id': name" format.
Yes, it sounds complicated, but it is not! Here, look at my sample config:

CustomItems:
Tools:
'BOW': Bow
'FLINT_AND_STEEL': Flint and steel
Armor:
'LEATHER_CHESTPLATE': Leather Armor
'CHAINMAIL_CHESTPLATE': Some other armor

You can just copy-paste it in your config at the very end of it and change the IDs. Names after ":" are just for your convenience and are not used anywhere in the code.

### How to blacklist items

You can prohibit players to repair certain items and also, separately, prohibit them from adding enchantments to certain items.

This is achieved through ItemBlacklist.Repair and ItemBlacklist.Enchant config sections, respectively.

Here is an example of such config:

ItemBlacklist:
Enchant:
- DIAMOND_SWORD
- GOLD_SPADE
Repair:
- GOLD_SPADE
- DIAMOND_SWORD

By default, this setting is not in your config and you have to add it manually.

You can copy-paste this snippet to the end of your config.

## Support links

* [Plugin page on dev.bukkit.org](http://dev.bukkit.org/bukkit-plugins/griswold/)
* [Plugin page on spigotmc.org](http://spigotmc.org/resources/griswold.49036/)
* [Russian discussion and support](http://rubukkit.org/threads/15343/)
* Feel free to suggest something or report bugs in Issues
* Your pull requests are always welcome!

## Stats:

[Stats are available here](https://bstats.org/plugin/bukkit/Griswold)