Git Product home page Git Product logo

luascript's Introduction

LuaScript License

Lua 5.4 language support for Godot Engine 3.1 and later

WIP (heavily updated so you can expect constants changes - no commitment with feature freezing at this moment)

Current progress: Currently I'm experimenting with parsers. The one I'm testing right is the PEGTL C++ library. With this in place it will be possible to start answering engine call backs, like for example, _ready(), _process() etc.

Features

  • Full Godot's gameplay API implementation (feature complete on par with GDScript)
  • Object Oriented Programming based on Lua's tables and metatables
  • Support for inheritance from Lua base class and file
  • Support for inheritance from native base class and file
  • Support for properties
    • Getters, setters and default values
    • Editing properties values in the property editor
  • Support for signals
    • Signal connect, emit and receive from code
    • Signal connect from the editor (currently not well supported by Godot)
  • Lua language coding in Godot's built in editor
    • On the fly source code linting and static analysis
    • On the fly source code syntax highlighting
    • Source code beautifier
      • Format the entire active file
      • Format the selected text
      • Format automatically when saving
    • Source code refactoring (currently not supported by Godot)
  • Lua language coding in external editor (possibly with the same capabilities as the built in editor)
  • Debugging tools (possibly with all Godot's debugging capabilities)
  • Tool creation to extend the built in editor functionalities
  • Support for advanced package assembling
    • Dead code elimination throught tree-shaking
    • Code uglifier and minifier
    • Compilation into binary bytecode
    • Compression or encryption

How to Build

My development environment is based on Linux and Mac so I don't know if it will work on Windows. I'm afraid probably not for the time been.

So first of all you have to have Godot successfully built in your system. That's out of scope of this simple how to.

Now, assuming you can git clone from GitHub, just clone LuaScript into Godo's source code 'modules' folder and then, build Godot again adding to the command line the following options

module_luascript_enabled=yes

If everything has gone well, you'll have a running Godot with Lua support!

For now not much is done but the simple fact of having Godot built with this initial code is already a cool thing!

So keep watching the development as I'm slowlly but steadly adding more features.

Have fun!

Issues and Support

Have a bug? Please create an issue here on GitHub!

https://github.com/perbone/luascript/issues

Versioning

For transparency and insight into our release cycle, releases are be numbered with the semantic versioning format: <major>.<minor>.<patch> and constructed with the following guidelines:

  • Breaking backwards compatibility bumps the major
  • New additions without breaking backwards compatibility bumps the minor
  • Bug fixes and misc changes bump the patch

Contributors

License

Copyright 2017-2019 Paulo Perbone

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License

luascript's People

Contributors

perbone avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.