Latest News Article

[Divisor]

Player API gives third party mods managed access to the main player class

Player API is an API which provides access to

• the client class "EntityPlayerSP" aka "vq" or
  
• the server class "EntityPlayerMP" aka "gi" or
  
• the bukkit class "EntityPlayer"

while minimizing conflicts between mods.



Current Versions:

Client 1.1 (for Minecraft 1.2.5)
Added hooks "getSpeedModifier" and "knockBack": Download from Mediafire or Dropbox

Server 1.2 (for Minecraft 1.2.5)
Added hook "canHarvestBlock": Download from Mediafire or Dropbox

Bukkit 1.4 (for CraftBukkit 1.2.5-R2.0)
Updated Player API for CraftBukkit 1.2.5-R2.0: Download from Mediafire or Dropbox

Installation:

For installation instructions:

• make sure you download the right file:
  
  • Client for client side mods that require Player API client
    
  • Server for server side mods that require Player API server
    
  • Bukkit for bukkit mods that require Player API bukkit
• read the "installation" section of your download's readme files

Incompatibilities

• Player API server is compatible with Minecraft Forge server, just install Player API server after Minecraft Forge server.

FAQs:

Spoiler

#1: I found a bug, how do I report it here, so you can fix it?

Spoiler

Describe the bug, in detail if necessary. When does it occur and under which circumstances?

Always include:

• your Player API type (client or server)
  
• your Player API version (maybe the bug you found has already been fixed in a later release)
  
• your Minecraft or Minecraft Server version (especially in the weeks after an minecraft upgrade)
  
• all other mods you had installed parallel to Player API when the bug occures
  
• the mod versions of all these other mods (don't forget to include other APIs like ModLoader, ModLoaderMp or MinecraftForge)
  
• the complete startup output from the client's or server's terminal window. (when you can't see the terminal windows have a look at the next FAQ's answer)
  
• if the bug crashes the game, the complete error message including it's stack trace (when you can't see the error message long enough continue reading this FAQs)
  
• the game mode the bug occured in: (SSP/Survival Single Player, SMP/Survival Multi Player, CSP/Creative Single Player or CMP/Creative Multi Player)

#2: My game crashes but I cannot see the error message long enough to copy it!

Spoiler

In windows start the minecraft client from the command line console using the following statement

java -Xincgc -Xmx1024M -Xms1024M -Djava.library.path=bin/natives -classpath bin/minecraft.jar;bin/lwjgl.jar;bin/lwjgl_util.jar;bin/jinput.jar net.minecraft.client.Minecraft

in your .minecraft directory.

If you need a minecraft server error message instead, start your server from the command line console using the following statement

java -cp minecraft_server.jar net.minecraft.server.MinecraftServer

in your minecraft_server.jar's directory.

If the java command coud not be found, make sure your java installations bin folder is included in the PATH environment variable of your system.

#3: The game crashes! I get the error message: "java.lang.NoClassDefFoundError: net/minecraft/server/MinecraftServer"!

Spoiler

You installed Player API server into the Minecraft client jar!

Your minecraft.jar is now corrupted. Delete it and restore your previous version from backup or start again with a clean copy.

#4: The game crashes! I get the error message: "java.lang.NoClassDefFoundError: net/minecraft/client/Minecraft"!

Spoiler

You installed Player API client into the Minecraft server jar!

Your minecraft_server.jar is now corrupted. Delete it and restore your previous version from backup or start again with a clean copy.

Developing:

If you require more hooks or access methods to make your mod work with Player API, you can either send me a private message or post here.

The additional code should then be in the next release.

Step by Step: Mod Adaption

Spoiler

One scenario of starting to develop with this mod is that you have a fully functional mod that overwrites the client/server main player class, and you want your mod to be compatible with other mods that are allready using Player API.

In this case the following steps are recommended:

• Outsource your mod specific code from EntityPlayerSP.java/EntityPlayerMP.java into a new mod specific class you create a single instance for each instance of the EntityPlayer class so that only the mod class field, some hook methods and some field accessors remain in EntityPlayerSP.java/EntityPlayerMP.java.
  
• make sure your mod works correctly.
  
• Embedd Player API into your development environment (in case of MCP that means to decompile the Player API classes using the MCP decompiling system)
  
• In case of MCP replace your modded EntityPlayerSP.java with the EntityPlayerSP.java from Player API client. (and import all other Player API client classes)
  
  • Let your specific mod class extend the PlayerBase class
    
  • Make sure your mod class is registered at the PlayerAPI class before the first player instance is created. (a ModLoader mod would be a good choice here)
    
  • Adapt all your hook listeners in your mod class to overwrite their corresponding PlayerBase methods.
    
  • Adapt all your field accessor references with references to PlayerAPI field accessors.
• Check whether required hooks are missing and send me a private message containing the the corresponding EntityPlayerSP/EntityPlayerMP method names (and wait until I updated Player API) if necessary.
  
• Make sure your mod works correctly.

Step by Step: Mod Creation

Spoiler

Another scenario is that you want to develop a new mod with Player API.

In this case the following steps are recommended:

• Embedd Player API into your development environment (in case of MCP that means to decompile the Player API classes using the MCP decompiling system)
  
• Start creating a new class that extends your Player APIs PlayerBase class.
  
• Make sure your mod's PlayerBase class is registered at the PlayerAPI class before the first player instance is created. (a ModLoader mod would be a good choice here)
  
• Overwrite the PlayerBase methods you need to make your mod work.

Example: Mod Structure

Spoiler

In the end you code should look something like this:

public class mod_MyModName extends BaseMod
{
	public void ModsLoaded()
	{
		PlayerAPI.register("MyModId", MyModPlayerBase.class);
	}
}

public class MyModPlayerBase extends PlayerBase
{
	public MyModPlayerBase(PlayerAPI playerapi)
	{
		super(playerapi);
	}

	// one of my hook functions
	public boolean canBreatheUnderwater()
	{
		if(myModIsActive)
		{
			// my code
			return myResult;
		}
		else
			return super.canBreatheUnderwater();
	}

	// another of my hook functions
	public void jump()
	{
		if(myModIsActive)
		{
			// my code
			if(callJumpOfEntityPlayerSP)
				player.canBreatheUnderwater();
			else if(callJumpOfEntityPlayer)
				player.canBreatheUnderwater();
			// my code
			if(doGigaJump)
				player.motionY = gigaJumpSpeed;
			else if(doMiniJump)
				player.motionY = miniJumpSpeed;
			// my code
		}
		else
			super.jump();
	}
}

Usage:

This API is currently used by the following mods:

• Aether (client)
  
• Battlegear (client)
  
• CJB Mods (client)
  
• Combat tweaks (client)
  
• Combat++ (client)
  
• Enchantable Bow Patch (client)
  
• Flan's Mod (client)
  
• MineFantasy (client)
  
• Single Player Commands Patch (client)
  
• ShockAhPI (client)
  
• Skills API (client)
  
• SkyrimCraft (client)
  
• Smart Moving (client, server & bukkit)
  
• Teams (server / 1.8.1)
  
• Sports Mod (client & server)
  
• Thirst Mod (server)
  
• Throw That Brick! (client)

Previous Versions:

Previous Versions (for Minecraft 1.2.5)

Client 1.0
Upgraded to Minecraft 1.2.5: Download from Mediafire or Dropbox

Server 1.1
Added hooks "attackTargetEntityWithCurrentItem", "canPlayerEdit" and "damageEntity": Download from Mediafire or Dropbox

Server 1.0
Upgraded to Minecraft 1.2.5: Download from Mediafire or Dropbox

Bukkit 1.3
Added support for attaching and detaching Player Bases on the fly: Download from Mediafire or Dropbox

Bukkit 1.2
Added hook "canHarvestBlock": Download from Mediafire or Dropbox

Bukkit 1.1
Added hooks "attackTargetEntityWithCurrentItem", "canPlayerEdit" and "damageEntity": Download from Mediafire or Dropbox

Bukkit 1.0
Created Player API for CraftBukkit 1.2.5-R1.0: Download from Mediafire or Dropbox

Previous Versions (for Minecraft 1.2.4)

Spoiler

Client 1.0
Upgraded to Minecraft 1.2.4, renamed hooks according to MCP 6.1 ("dropCurrentItem" to "dropOneItem", "getEntityBrightness" to "getBrightness", "getEntityBrightnessForRender" to "getBrightnessForRender" and "setEntityDead" to "setDead"): Download from Mediafire or Dropbox

Server 1.0
Upgraded to Minecraft 1.2.4, renamed hooks according to MCP 6.1 ("dropCurrentItem" to "dropOneItem", "getEntityBrightness" to "getBrightness" and "setEntityDead" to "setDead"): Download from Mediafire or Dropbox

Bukkit 1.1
Added MC Port Central bukkit server compatibility, applied bugfix from MC Port Central bukkit server to ensure overwrite compatibility: Download from Mediafire or Dropbox

Bukkit 1.0
Created Player API for CraftBukkit 1.2.4-R1.0, added hook "interact", added method accessors for not public methods, added super method accessors for not hooked methods, renamed hooks according to MCP 6.1 ("dropCurrentItem" to "dropOneItem", "getEntityBrightness" to "getBrightness" and "setEntityDead" to "setDead"): Download from Mediafire or Dropbox

Previous Versions (for Minecraft 1.2.3)

Spoiler

Client 1.2
Added method accessors for not public methods, added super method accessors for not hooked methods: Download from Mediafire or Dropbox

Client 1.1
Added hooks "displayGUIBrewingStand", "displayGUIEnchantment" and "swingItem": Download from Mediafire or Dropbox

Client 1.0
Upgraded to Minecraft 1.2.3: Download from Mediafire or Dropbox

Server 1.3
Added method accessors for not public methods, added super method accessors for not hooked methods, applied bugfix from MinecraftForge server 1.4.1: Download from Mediafire or Dropbox

Server 1.2
Added hook "interact": Download from Mediafire or Dropbox

Server 1.1
Fixed closing inventory error: Download from Mediafire or Dropbox

Server 1.0 inventory BUGGY (use server version 1.1 instead)
Upgraded to Minecraft 1.2.3: Download from Mediafire or Dropbox

Previous Versions (for Minecraft 1.1)

Spoiler

Client 1.2
Added hook "canPlayerEdit", fixed version logging: Download from Mediafire or Dropbox

Client 1.1
Fixed error handling: Download from Mediafire or Dropbox

Client 1.0 error handling BUGGY (use client version 1.1 instead)
Upgraded to Minecraft 1.1, improved decompile ability: Download from Mediafire or Dropbox

Server 1.3
Fixed version logging: Download from Mediafire or Dropbox

Server 1.2
Applied bugfix from Minecraft Forge server to ensure overwrite compatibility: Download from Mediafire or Dropbox

Server 1.1 MinecraftForge overwrite incompatible (use server version 1.2 instead)
Fixed error handling: Download from Mediafire or Dropbox

Server 1.0 error handling BUGGY (use server version 1.1 instead)
Upgraded to Minecraft 1.1, improved decompile ability: Download from Mediafire or Dropbox

Bukkit 1.3
Updated Player API for CraftBukkit 1.1-R4, fixed version logging: Download from Mediafire or Dropbox

Bukkit 1.2
Updated Player API for CraftBukkit 1.1-R3: Download from Mediafire or Dropbox

Bukkit 1.1
Updated Player API for CraftBukkit 1.1-R2: Download from Mediafire or Dropbox

Bukkit 1.0
Created Player API for CraftBukkit 1.1-R1: Download from Mediafire or Dropbox

Previous Versions (for Minecraft 1.0.0)

Spoiler

Client 1.6
Added hook "canBreatheUnderwater": Download from Mediafire or Dropbox

Client 1.5
Added hook "getSleepTimer": Download from Mediafire or Dropbox

Client 1.4
Added hook "getItemIcon": Download from Mediafire or Dropbox

Client 1.3
Added hook "setPositionAndRotation": Download from Mediafire or Dropbox

Client 1.2
Added hook "isSprinting", added standard output and java logging: Download from Mediafire or Dropbox

Client 1.1
Added hooks "addExhaustion" and "isEntityInsideOpaqueBlock, added local constructor hooks, corrected field accessor methods: Download from Mediafire or Dropbox

Client 1.0
Upgraded to Minecraft 1.0.0, improved and standardized hook patterns: Download from Mediafire or Dropbox

Server 1.6
Added hooks "setPosition" and "isPlayerSleeping", fixed dimension change inventory item disappearance: Download from Mediafire or Dropbox

Server 1.5
Added hook "isEntityInsideOpaqueBlock": Download from Mediafire or Dropbox

Server 1.4
Added standard output and java logging: Download from Mediafire or Dropbox

Server 1.3
Fixed closing inventory error: Download from Mediafire or Dropbox

Server 1.2 inventory BUGGY (use server version 1.3 instead)
Fixed zip file name from MC 1.0.0 to MC 1.0.1: Download from Mediafire or Dropbox

Server 1.1 file name BUGGY (is actually for Minecraft server version 1.0.1)
Added hooks "addExhaustion" and "isEntityInsideOpaqueBlock, added local constructor hooks, corrected field accessor methods: Download from Mediafire or Dropbox

Server 1.0 file name BUGGY (is actually for Minecraft server version 1.0.1)
Upgraded to Minecraft 1.0.0, improved and standardized hook patterns: Download from Mediafire or Dropbox

Bukkit 1.0
Created Player API for CraftBukkit 1.0.1-R1: Download from Mediafire or Dropbox

Previous Versions (for Minecraft Beta 1.8.1)

Spoiler

Client 1.5
Added hook "onKillEntity": Download from Mediafire or Dropbox

Client 1.4
Added hooks "getFOVMultiplier" and "getItemIcon": Download from Mediafire or Dropbox

Client 1.3
Improved null handling of hook "rayTrace": Download from Mediafire or Dropbox

Client 1.2
Took over mod from jamioflan: Download from Mediafire or Dropbox

Server 1.1
Added hook "onKillEntity": Download from Mediafire or Dropbox

Server 1.0
Took over mod from jamioflan: Download from Mediafire or Dropbox

Bukkit Versions
Have a look at krnlyng's thread ModLoaderMP for CraftBukkit and Canary

Previous Versions (for Minecraft Beta 1.7.3)

Spoiler

Client 1.7
Created by jamioflan: Download from Mediafire or Dropbox

Server 1.5
Created by jamioflan: Download from Mediafire or Dropbox

Bukkit Versions
Have a look at krnlyng's thread ModLoaderMP for CraftBukkit and Canary

[Delta565]

Yey!
Thank you for that
Here

[Divisor]

Released client version 1.3 - Improved null handling of hook "rayTrace".

[kaimarohero]

So, with this.. it's possible to control a connected client with the mod class installed, if you have the plugin installed on the server?

[Divisor]

kaimarohero, on 24 October 2011 - 06:52 PM, said:

So, with this.. it's possible to control a connected client with the mod class installed, if you have the plugin installed on the server?

No, it's just a class access API.

Client and server part are strictly seperated. They are two different APIs that somehow happen to do the same thing - one at the client, the other one at the server.

[leonardo2009]

It's The Best mod

[BlueCreeper]

I get a black screen after Mojang appears. I have Flan's Planes, Vehicles, and Guns on, and I'm trying to get the Aether mod. This is my second to last requirement (AudioMod).

[pwnedgod]

BlueCreeper, on 28 October 2011 - 04:09 AM, said:

I get a black screen after Mojang appears. I have Flan's Planes, Vehicles, and Guns on, and I'm trying to get the Aether mod. This is my second to last requirement (AudioMod).

Use this to get a error report and paste it here.

[Divisor]

BlueCreeper, on 28 October 2011 - 04:09 AM, said:

I get a black screen after Mojang appears. I have Flan's Planes, Vehicles, and Guns on, and I'm trying to get the Aether mod. This is my second to last requirement (AudioMod).

Can you give me some more information?

Like:

• your Minecraft version
  
• your Player API version
  
• the mod versions of all these mods
  
• the complete startup output from the client's terminal window
  
• the complete error message including it's stack trace

[BlueCreeper]

Divisor, on 30 October 2011 - 02:59 PM, said:

Can you give me some more information?

Like:

• your Minecraft version
  
• your Player API version
  
• the mod versions of all these mods
  
• the complete startup output from the client's terminal window
  
• the complete error message including it's stack trace

-MineCraft 1.8.1.
-Client 1.3.
-Planes v16, Vehicles v4, WW2 Guns v3.
I'll look at the other ones. Thanks pwnedgod, now I know what they mean with the error log thing. Just got to reinstall, lost my .jar file.

[BseagullMC]

what does it actually do?

[Divisor]

BseagullMC, on 02 November 2011 - 02:39 AM, said:

what does it actually do?

It solves parallel file overwriting incompatibility issues between mods for the client file qs.class and the server file ek.class. Of course the corresponding mods need to actively outsource their file overwriting functionality to the Player API and therefore depend on it to make it work.

[Binkan Salaryman]

Divisor, on 24 October 2011 - 08:58 PM, said:

No, it's just a class access API.

Client and server part are strictly seperated. They are two different APIs that somehow happen to do the same thing - one at the client, the other one at the server.

Well... If it is managed to work with Player Model API (click signature)
then it would be sooo awesome But - I am not really fit in entity thing :'(

So, can you explain me how to use your api?

[pwnedgod]

Binkan Salaryman, on 02 November 2011 - 07:52 AM, said:

Well... If it is managed to work with Player Model API (click signature)
then it would be sooo awesome But - I am not really fit in entity thing :'(

So, can you explain me how to use your api?

Actually. Player Model API should use Player API instead.

[Binkan Salaryman]

pwnedgod, on 02 November 2011 - 08:11 AM, said:

Actually. Player Model API should use Player API instead.

See it as you like... My mod has its root in the render files and doesn't modify entity files.
That makes it very compatible. But of course I can't fulfill the wishes of the thread posters
spamming "DON'T MAKE ONLY THE MODEL OMG!!" with that. If you are all in all a good modder we
should really work together and make a mod for switching to all possible mobs...

[Divisor]

Binkan Salaryman, on 02 November 2011 - 07:52 AM, said:

... So, can you explain me how to use your api?

I had a look at your Player Model API mod. It does not override qs.class so it currently has no use for the Player API mod.

If you are planning to continue developing your mod so that it has to overwrite qs.class to function correctly, you might find the Player API mod very useful to outsource this critical code.

To do so:

• decompile the latest version of the Player API client mod into your programming environment
  
• create a new class extending the class PlayerBase
  
• put all your code from EntityPlayerSP into this class
  
• make sure to register your class using PlayerAPI.RegisterPlayerBase before the first player entity is created (doing this in a ModLoader mod class constructor is normally a good choice)
  
• make your class work
  
  • make sure you are overwriting the right method
    
  • make sure calling the right methods of the new EntityPlayerSP class
    
  • if you are missing methods or functionality send me a private message describing the additionaly needs of your mod
• recompile your code as usual
  
• make sure to exclude qs.class and all Player API classes from your own mod package

Binkan Salaryman, on 02 November 2011 - 08:18 AM, said:

See it as you like... My mod has its root in the render files and doesn't modify entity files.
That makes it very compatible. But of course I can't fulfill the wishes of the thread posters
spamming "DON'T MAKE ONLY THE MODEL OMG!!" with that. If you are all in all a good modder we
should really work together and make a mod for switching to all possible mobs...

What specifically do those posters want you to add to your mod?

[Binkan Salaryman]

Divisor, on 02 November 2011 - 09:35 PM, said:

What specifically do those posters want you to add to your mod?

Well.. they have MANY ideas... Look here:

Spoiler

"Oh cool! Lol XD. Will you be able to "float" as a Ghast? XD Lol well I can't wait for the next update . I really enjoy this mod. And I hope I can actually learn some java soon so I can create my own mobs XD."


"dont make only model! POWERS! EXPLODEEE! TELEPORT! AGGERSIVE MOBS DONT ATTACK YOU WEN NO PLAYER!!! DO IIIT!"


"Now you should be totally awesome and script it so we can use the individual mob's abilities, such as teleporting as enderman, or exploding as a creeper. And a button for making selected mob's noise."


"Make it so that pressing a key performs a specific action for that mob.
P for endermen makes you pick up a block (no matter what it is).
P for creepers (held down) makes you explode.
P for skeleton makes the bow fire.
etc."


"Looks pretty cool. Keep up the good work.

P.S. Any chance you could make it possible to have a rendermob file instead of just the Model file?"

"Why not add the wolf Model?If you are not working on it yet,but its just a sugestion Great Mod dude"


"Can u please add the monsters abilities, and make them not walk through stuff when they r too big (so make their size really their size)

So bassically ghasts can fly and shoot, creepers can explode (done before), endermen can teleport, chicken can glide (done before), and those types of things

hope i helped"


etc...

That would require a total change, don't it?
For every player a render, model and entity extended class + a way to put them together...

[dirtbikerty99]

pwnedgod, on 30 October 2011 - 10:34 AM, said:

Use this to get a error report and paste it here.

i am gonna sound like a nube but how do you copy?

[pwnedgod]

Can you make a Better than wolves compatibility patch? After a recent update BTW edits the qs.class.

_______________________________________________________________________________________

dirtbikerty99, on 07 November 2011 - 12:48 AM, said:

i am gonna sound like a nube but how do you copy?

Nevermind use this instead and if the error window appears copy and paste it here:
http://www.mediafire...s2t39voa4nala6r

[dirtbikerty99]

pwnedgod, on 07 November 2011 - 01:19 PM, said:

Can you make a Better than wolves compatibility patch? After a recent update BTW edits the qs.class.

_______________________________________________________________________________________



Nevermind use this instead and if the error window appears copy and paste it here:
http://www.mediafire...s2t39voa4nala6r

how do you copy the error report???