MCLuaBukkit

Table of Contents

Ever wanted to make a Bukkit plugin, but didn't know how? Want to edit code in-game and test it right away? MCLuaBukkit allows use of the Bukkit API with Lua, a simple, yet powerful, scripting language.

Quick Start

Example Code

Overview

MCLuaBukkit provides a Lua VM with mappings to the Bukkit API, and a few ways to load code into the VM. It allows developers to create Bukkit plugins in Lua. This means plugins with less mistakes, more security, and smaller size. Here's an example of an MCLuaBukkit plugin:

events.onPlayerInteract:add(function(p) x,y,z = p:getTargetBlock(100) p:getLocation():lightning(x,y,z) end)

This simple plugin strikes lightning where players click. It could easily be made to work only for certain players. MCLuaBukkit provides 3 ways for server operators to load Lua plugins:

By Files Files ending in ".lua" inside MCLuaBukkit's data folder will be loaded as Lua plugins.
By Chat The /lua command will run Lua code in-game.
By Book And Quill The /luaload command will run Lua code contained inside a book and quill.

Lua APIs Added

Server API
Event API
Player API
World API
Config API
Inventory API

Commands

/lua <code> Runs specified code.
/luaload Runs code from a book and quill in the player's hand.

Permissions

mcluabukkit.lua Allows execution of Lua code in-game.

Video

Comments

_ForgeUser10416847
- Join Date: 1/19/2013
- Posts: 0
- Member Details
#51 _ForgeUser10416847

View User Profile

Send Message

Posted Jun 5, 2015
Sadly my server is the only server using the plugin. maybe I am the only one qualified enough to write plugins in lua? well lucky for you I am using this plugin on two networks soon :)

Rollback Post to Revision RollBack
Selim_042
- Join Date: 5/7/2012
- Posts: 2
- Member Details
#50 Selim_042

View User Profile

Send Message

Posted Nov 6, 2014
@nedurland

These plugins don't go in the Lukkit folder, and there isn't a command to run the plugins. They currently run on startup.

Rollback Post to Revision RollBack
Selim_042
- Join Date: 5/7/2012
- Posts: 2
- Member Details
#49 Selim_042

View User Profile

Send Message

Posted Nov 5, 2014
This is an awesome plugin, I will be using this on my server, but do you have an ETA on when there will be commands? And, I think you should be able to write your own API's like you can in ComputerCraft, could be useful.

Last edited by Selim_042: Nov 5, 2014

Rollback Post to Revision RollBack
_ForgeUser10814826
- Join Date: 3/24/2013
- Posts: 33
- Member Details
#48 _ForgeUser10814826

View User Profile

Send Message

Posted Mar 28, 2014
could you make an example lua plugin, if i copy the code above and put in .lua and then in the lukkit folder and i use the command it doesnt work. it says this in the console: http://f63.net/i/update_available_on_snapr.pw-b211ac100e92098.png

Rollback Post to Revision RollBack
_ForgeUser12212171
- Join Date: 9/17/2013
- Posts: 1
- Member Details
#47 _ForgeUser12212171

View User Profile

Send Message

Posted Sep 17, 2013
I'm a huge fan of your plugin and have a question (actually two): Is there a way to use the API's of other plugins? (luajava keeps giving me class not found errors) Is there a way to hook into any event desired?

Keep up the good work!

Rollback Post to Revision RollBack
_ForgeUser12188370
- Join Date: 9/14/2013
- Posts: 1
- Member Details
#46 _ForgeUser12188370

View User Profile

Send Message

Posted Sep 14, 2013
Hi, nice plugin

I dont know if you are still updating this (i hope you are) but can you make a list with all functions?

I know I can find all functions in the mcluabukkit folder but can you make a list with a description of what it does? Thank you :)

Rollback Post to Revision RollBack
_ForgeUser8116789
- Join Date: 12/21/2011
- Posts: 1
- Member Details
#45 _ForgeUser8116789

View User Profile

Send Message

Posted Aug 26, 2013
Is there a way of getting / setting scoreboard values, such as player:setScoreboardValue(objective, value) and player:getScoreboardValue(objective)?

Rollback Post to Revision RollBack
_ForgeUser8080179
- Join Date: 12/14/2011
- Posts: 18
- Member Details
#44 _ForgeUser8080179

View User Profile

Send Message

Posted Aug 7, 2013
@ExxGen

To send chat as a player, use something like this:

chat("<" .. player .. "> " .. message)

To send chat to a player:

player = getPlayer(name) player:chat(message)

As for using Bukkit events directly, you might be able to pull it off with LuaJava, but I haven't done it myself. The next release will have a more advanced event system that should be able to do this.
Rollback Post to Revision RollBack
_ForgeUser8080179
- Join Date: 12/14/2011
- Posts: 18
- Member Details
#43 _ForgeUser8080179

View User Profile

Send Message

Posted Aug 7, 2013
@monowii

This script should run from /lua, as long as you run the lines with separate commands, like this:

/lua Bukkit = luajava.bindClass("org.bukkit.Bukkit")

/lua Bukkit:broadcastMessage("Hi from LuaJava!")

Also, you only have to put lib-luaj into the jar file if you are recompiling MCLuaBukkit. Sorry about not making that clear.

Last edited by _ForgeUser8080179: Aug 7, 2013

Rollback Post to Revision RollBack
monowii
- Join Date: 2/7/2012
- Posts: 86
- Member Details
#42 monowii

View User Profile

Send Message

Posted Jul 26, 2013
I get this error when I try to run a script:
[MCLuaBukkit] Lua script loaded by lua command produced error: org.luaj.vm2.LuaError: [string "lua command"]:1: syntax error

And the script is just:
Bukkit = luajava.bindClass("org.bukkit.Bukkit")
Bukkit:broadcastMessage("Hi from LuaJava!")

I also put the content of lib-luaj in MCLuaBukkit.jar
I use CB 1.6.2-R0.1 (Build #02820) and MCLuaBukkit 0.63

Edit: This work only with books

Last edited by monowii: Jul 26, 2013

Rollback Post to Revision RollBack
_ForgeUser8987661
- Join Date: 6/5/2012
- Posts: 39
- Member Details
#41 _ForgeUser8987661

View User Profile

Send Message

Posted Jul 20, 2013
@ExxGen

To answer your first question, you can use chat() to send a message to a player, like this:

player = getPlayer("Weegeemang") player:chat("Hello!")
Rollback Post to Revision RollBack
_ForgeUser11881529
- Join Date: 7/18/2013
- Posts: 1
- Member Details
#40 _ForgeUser11881529

View User Profile

Send Message

Posted Jul 18, 2013
I want to send chat as a player, how can i do that?

And, is there a way to use events like org.bukkit.event.player.PlayerChatEvent directly?

Rollback Post to Revision RollBack
_ForgeUser8987661
- Join Date: 6/5/2012
- Posts: 39
- Member Details
#39 _ForgeUser8987661

View User Profile

Send Message

Posted Jul 3, 2013
@carocrazy132

Caro, I've personally used onPlayerInteract as a block breaking event. Granted, it may not be as good as an onBlockBreak event, but it can certainly be used as such for the most part.

Last edited by _ForgeUser8987661: Jul 3, 2013

Rollback Post to Revision RollBack
_ForgeUser8080179
- Join Date: 12/14/2011
- Posts: 18
- Member Details
#37 _ForgeUser8080179

View User Profile

Send Message

Posted Jun 28, 2013
@carocrazy132

events.onPlayerInteract can be used to tell when block breaking is started. If you need more advanced tracking, please let me know.

Rollback Post to Revision RollBack
_ForgeUser8430060
- Join Date: 2/15/2012
- Posts: 2
- Member Details
#36 _ForgeUser8430060

View User Profile

Send Message

Posted Jun 26, 2013
This has to be a record for how much effort was put into something useless. How about an events.onBlockBreak so that all the other functions are actually useful? Jesus in a game about breaking blocks you sure missed the target by a few miles, didn't you?

Rollback Post to Revision RollBack

_ForgeUser8080179

Join Date: 12/14/2011
Posts: 18
Member Details

#35 Posted Jun 10, 2013

@lieudusty

Sorry about that. I should have checked if the script worked before posting it. Here's the fixed version:

-- Variables
smokedPlayer = "ndinventor"

-- Bind Classes
Bukkit = luajava.bindClass("org.bukkit.Bukkit")
Effect = luajava.bindClass("org.bukkit.Effect")
Face = luajava.bindClass("org.bukkit.block.BlockFace")

-- When a player moves
events.onPlayerMove:add(function(p)
    if p:getName() == smokedPlayer then
        -- Get the player's current world
        w = p:getLocation()
        -- Spawn the smoke effect
        Bukkit:getWorld(w:getName()):playEffect(
            Bukkit:getPlayer(p:getName()):getLocation(),
            Effect.SMOKE,
            Face.UP)
    end
end)

As for setting velocity, here's a script for that:

-- Bind Classes
Bukkit = luajava.bindClass("org.bukkit.Bukkit")
Vector = luajava.bindClass("org.bukkit.util.Vector")

Bukkit:getPlayer("ndinventor"):setVelocity(luajava.new(Vector, 0, 1, 10))

_ForgeUser7403596
- Join Date: 8/18/2011
- Posts: 8
- Member Details
#34 _ForgeUser7403596

View User Profile

Send Message

Posted Jun 9, 2013
@ndinventor

Interesting... I tried that code and it errored:
[MCLuaBukkit] Script run by event listener produced error: org.luaj.vm2.LuaError: @plugins/MCLuaBukkit/test.lua:19 vm error: java.lang.IllegalArgumentException: Wrong kind of data for this effect!

EDIT: Also is there a way to set the player's velocity?
Last edited by _ForgeUser7403596: Jun 10, 2013

Rollback Post to Revision RollBack

_ForgeUser8080179

Join Date: 12/14/2011
Posts: 18
Member Details

#33 Posted Jun 9, 2013

@justync7

You would have to use LuaJava, as MCLuaBukkit doesn't have API mappings to the effect system yet. The code would look something like:

-- Variables
smokedPlayer = "ndinventor"

-- Bind Classes
Bukkit = luajava.bindClass("org.bukkit.Bukkit")
Effect = luajava.bindClass("org.bukkit.Effect")

-- When a player moves
events.onPlayerMove:add(function(p)
    if p:getName() == smokedPlayer then
        -- Get the player's current world
        w = p:getLocation()
        -- Spawn the smoke effect
        Bukkit:getWorld(w:getName()):playEffect(
            Bukkit:getPlayer(p:getName()):getLocation(),
            Effect.SMOKE,
            0)
    end
end)

_ForgeUser7196145
- Join Date: 7/13/2011
- Posts: 1
- Member Details
#32 _ForgeUser7196145

View User Profile

Send Message

Posted Jun 9, 2013
Is there anyway to make a particle effect that follows a players footsteps but only when they are moving?

Rollback Post to Revision RollBack
_ForgeUser8080179
- Join Date: 12/14/2011
- Posts: 18
- Member Details
#31 _ForgeUser8080179

View User Profile

Send Message

Posted May 26, 2013
@Nixola97

".txt" files only work in 0.6. Come 0.63, they will no longer work. This is because the old script loader thought that "config.yml" was a Lua script, which meant that I couldn't add a config to MCLuaBukkit without changing that.

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

54671
Created

Mar 26, 2013
Last Released File

Never
Total Downloads

2,271
License

GNU Lesser General Public Lice...

Bukkit

MCLuaBukkit

Bukkit Plugins

MCLuaBukkit

Table of Contents

Quick Start

Example Code

Overview

Lua APIs Added

Commands

Permissions

Video

Comments

About This Project

Categories

Members

Recent Files

Bukkit