fallenmoonnetwork / canarylib

CanaryLib

Last Build Last Successful Build ChangeLog

CanaryMod is a Minecraft Server wrapper and library with built-in data management features as well as player permissions and groups management. CanaryMod provides a stable and feature-rich framework that makes sure that Plugins written today, will still work in months without the need of updating on each Minecraft update. As server owner, this allows you to spend more time on managing your server, making it awesome, instead of waiting for all your plugins to update each time.

As a Plugin Developer, our Mod allows you to concentrate on the things that make your Plugin great and unique - you won’t ever need to bother about implementing data storage or resolving dependencies with other plugins. We do the dirty work for you, you go and make amazing plugins. It’s as easy as that!

This repository contains the library.

Plugin Development

Maven

    <dependency>
        <groupId>net.canarymod</groupId>
        <artifactId>CanaryLib</artifactId>
        <version>[0.9,)</version> <!-- Will always use the latest version found (including snapshots)-->
    </dependency>

Repository:

    <repository>
        <id>vi-repo</id>
        <name>Visual Illusions Repository</name>
        <url>http://repo.visualillusionsent.net</url>
    </repository>

Non-Maven

Add CanaryLib (unshaded or shaded) and VIUtils 1.1.1 (if using unshaded) to the build path of your Plugin project. VIUtils downloads can be found at http://wiki.visualillusionsent.net/VIUtils or http://repo.visualillusionsent.net/net/visualillusionsent/viutils/

Java Docs

Official JavaDocs

http://build.canarymod.net/job/CanaryLib/javadoc/

JavaDoc Alternate Locations http://canary.playblack.net/docs/ http://docs.visualillusionsent.net/CanaryLib/

VIUtils Library Docs http://docs.visualillusionsent.net/VIUtils/

Pull Requests

It helps us when others take the time to submit fixes rather than just pointing out bugs/inconsistencies. However, We have standards for the sources we have. Things like formatting and generally following the Sun/Oracle coding standards

Source Formatting and requirements

• No tabs; use 4 spaces instead.

• No trailing whitespaces.

• No CRLF line endings, LF only.

  • Git can handle this by auto-converting CRLF line endings into LF when you commit, and vice versa when it checks out code onto your filesystem. You can turn on this functionality with the core.autocrlf setting. If you’re on a Windows machine, set it to true — this converts LF endings into CRLF when you check out code. (git config --global core.autocrlf true)
  • Eclipse: http://stackoverflow.com/a/11596227/532590
  • NetBeans: http://stackoverflow.com/a/1866385/532590
  • IntelliJ: http://stackoverflow.com/a/9872584

• JavaDocs well written (as necessary)

• Matching how we format statements

    public class MyClass { //note the whitespace
        public void function() {
            if (something) {
                // do stuff
            }
            else if (somethingElse) {
                // do other stuff
            }
            else {
                // do else stuff
            }
        }
    }
  

canarylib's Issues

missing methods

im missing
player.getLevel();
player.setXP()
warp.getLocation();
Home.getLocation();
player.setCreatetiveMode(boolean); since we have player.isInCreativeMode();

hook onConsoleCommand not working in gui

with .bat server you can parse console commands but when you launch it with gui it does nothing besides showing unknown command ?

addition hook CommandCheck

i want to see a commandcheck hook where you can allow or deny the command skipping the permissions

World.getBlockAt(x, y, z)

Maybe I'm just missing it, but I can't seem to find this method. I think it's pretty crucial though.

new methods

couldnt find some methods

player.getInventory.getItemFromSlot();
and world.Explode(x,y,z,power);
player.isOp();
player.setOp(): ?

also
some replacement for
oworld.a(new OEntityLightningBolt(oworld, player.getX(), player.getY(), player.getZ()));?

Plugin conflicting with itself

When disabling and enabling plugins multiple time I got the message
2012-07-21 21:13:17 [WARNING] Plugin 'CCPlugin' and 'CCPlugin' shouldn't have the same priority. Edit Canary.inf to resolve the conflict.
The plugin seams to conflict with itself.

Thanks,

WWOL

im missing propertiesfile methods

couldnt find any propertiesfile methods are the method names changed or isnt it implemented yet

listwarps empty

warps don't get added to /listwarps on load or when using a plugin to create a warp, only temporarily when using /setwarp

Kick hook needs onKick in plugin listener

onBlockRightClicked issues

RightClickHook.getBlockPlaced() is actually the block you click, and getBlockClicked() is null if your hand is empty but the type is not what you hold, it's always from 1 to 5 depending on what direction you're facing.

Also, the item in your hand is null (or has id 0) the first time you right click, but after that it gets the correct id. Might be only for items you have when you log in.

I think it's only for onBlockRightClicked because onBlockPlace works fine.

Investiage (and fix?) the Win8 folder creation issue...

It appears that on (some?) windows 8 machines the XmlDatabase fails to properly write data to disk. It seems to be a win8 only issue.

Arrows don't shoot

When I fire a bow, I can pull it back fine, but when I release it no arrow comes out. The arrow is removed from my inventory, but an inventory refresh returns the arrow and the restores the damage on the bow.

Implement /reload

The reload command with all its functionality is a critical feature and must be implemented.
It must reload the flatfile database, refresh backbone and configuration caches, and refill variables in the original minecraft code to make the changes take effect.

CommandSystem checks for CommandBlock

so we don't get a CommandException when using a CommandBlock to execute commands

Add Damage Values where necessary.

PluginLoader should verify dependencies upon reloading a plugin.

The plugin might crash badly when a new dependency is not loaded. The CANARY.INF could have been changed between reloads.

Default group is not recognized ...

... if it's not the first in line. This should be an issue with the Groups and Users backbone. Might be an easy fix, probably something incredibly stupid. My guess is that it's in the constructor of said backbone where it sorts out the loaded groups.

config folder not creating

im using windows and the config folder isnt creating automatically (using java 7 and 6)
http://pastebin.com/FbhuQApr

HealthChange with source of health change

As requested by a couple of users

Animal & Item creation for Dimension

There is already a createMob in Dimension which will return a new Instance of a Mob.
Additionally there needs to be createItem and createAnimal, maybe even createLiving methods so Plugins that only use the Lib can create new stuff like that instead of including CanaryMod.jar.

Create better default settings...

... for Permissions and groups so the server is runnable in a basic form out of the box.
Should include:
Permissions: =true, canary.world.=true, canary.command.=true
Groups: players, mods, admins
rels: * to admins, canary.world to players/mods, canary.command. to mods

Adding 'moardimensions' system: allowing more than 3 dimensions in a world.

getItemHeld & getSlot

getItemHeld does not recognise the item when you login after a server reboot

and getSlot doesn't return null. It returns a NullPointerException instead =/

System-Default hook priorities fail

System default hook priorities make registering a plugin with them fail.
Pluin.getPriorityNode(name) must get an oveload for default hook priorities and their values,
and return a repsective priority node so registering with default priorities will still be possible!

Server reload needs to reload data in Player too

To make sure a reconnection is not necessary.

Factory

Make factory classes to get around the fact the plugin devs can't go new Item() because it is an interface.
Without a factory devs have to add CanaryMod the the build path and use new CanaryBlock().

@damagefilter
@Jarvix
Thoughts?

The way I have it set out at the moment is everything is in the net.canarymod.api.factory package.
For a dev it is simple.
Canary.factory().itemFactory().newItem(int id);
There are lots of overloads for handling enchantments, damage etc.

WWOL

Implement missing system commands

Add facility for adding non-native worlds to servers tick loop

Request: getEntityLivingList() method in class World

As title as description.

missing rot methods

im missing player.rotX y z etc can these be implemented
(also bump for fixing signchange :))

Warps overriding is glitchy

System does not check if a player is allowed to override a warp (override private with public warp (same name) for example).
That will cause some nasty trouble. Needs some checks if a warp can be changed before it is executed on the database.
Also: Needs to properly override all properties including isHome and "owner"

Permission query priorities

Permission Query is pretty dumb at the moment and needs some more intelligence.
That "explicitly deny a permission" thing doesn't work if there's an asterisk on the path.
That means if the asterisk is true but any subsequent nodes are not, it needs to know that and check
the full path instead of only until it reaches the asterisk.

item methods

im missing an method to get the item name
(item.getType.toString()) in old canary
also for damaged items me and dark wrote a piece for iAuction maby you could use it http://pastebin.com/Fv9BrkQY

item.setSlot(item,slot); doesnt work with parameter slot

also missing something like
player.swichworlds(world); player.swichdimension(dim); ?

Convert vanilla world format to Canary world format

Implement a modular command system?

It's possibly preferable to implement a modular command system for both native and plugin commands, where plugins can add commands using this.addCommand(CommandHandler, String command...), where CommandHandler takes a help description much like BaseCommand in CanaryMod.

A couple requested methods

I've been working a lot with the newest creeper (0.3), and I have found a need for a couple of methods:

playerInstance.isBlocking() - Returns whether or not the player is blocking with a sword
playerInstance.hasPotionEffect(PotionEffect e) - Check if player has a give potion effect. I am looking for this one in particular, but I presume that a whole potion effect API needs to be added because I don't seem to see anything like it in the docs.
vehicleInstance.setPassenger(Entity e) - I swear this existed before the update (not sure if it ever worked)

EDIT: Forgot to mention entityInstance.remove(), entityInstance.destroy() or something similar.
EDIT2: Just remembered playerInstance.isInVehicle() for determining whether or not a player is in a boat or minecart

Register commands to Help system

That might be a tricky thing to do as the help system is probably not loaded when the commands enum is processed
and therefore there is no access to the Help system.

onSmelt

I would love to see something similar to onCraft, but for furnaces. I understand that you have more important issues at the moment, like fixing onCraft, but I thought I'd mention this.

Allow plugins to implement custom databases.

There is a problem to be solved before this can be implemented: load order. Plugins are loaded after the database.

Duplicated commands on reload

When reloading a plugin I get a DuplicatedCommandException saying the command already exists.
This breaks plugin reload.

WWOL

Add translation to all userland output

Add maven

Add maven to Lib and Recode for easy project building.

onCraft additions

I would really like to see the following things added to the onCraft hook:

1. Make it a cancelable hook
2. Retrieve the items in the crafting slots and their locations (probably in a small array)

Kick and Ban hooks need reasons

getKickReason() getBanReason() or similar

Command (Small) Refactor

@damagefilter
@darkdiplomat

When adding commands the logic is split into console and player methods. Often for simple commands these are the same. The only thing different is permission checking.
Why can't these be merged into the one method. MessageReciever can check permissions and send messages to the command caller so I see no reason to split it.
That said for the more advanced commands (or where the console can't be used) could still split the logic.

Thanks,

WWOL

Request: onSignShow hook for recode (SignShowHook)

I simply request this;
https://github.com/FallenMoonNetwork/CanaryMod/blob/crow/src/PluginListener.java#L755
hook to be added to the recode.

Allowing custom world generation for multiworld.

calHook in HookExecutor needs refinement

callHook does not consider Plugin priorities yet, however it should. Changes must include:

• High and Critical priority Plugins must get hooks regardless of their cancel-state
• (Suggestion) Low priority Plugins could receive cancelled hooks for monitoring stuff.

Custom Crafting/Smelting Recipes

Allowing adding of custom Crafting and Smelting Recipes

ConfigurationFile paths

When creating a ConfigurationFile the path must be split by a / for the auto creation to work. This caused a bit of trouble when I was using File.seperator and wondering why it didn't work. I had to look at the source to figure it out. Perhaps it should use lastIndexOf(File.seperator) instead of lastIndexOf("/")? Or just replace all File.seperator with "/"?

Thoughts?

WWOL