https://github.com/dail8859/LuaScript

Notepad++ plugin for Lua scripting capabilities
https://github.com/dail8859/LuaScript

lua notepad-plus-plus plugin

Last synced: 7 months ago
JSON representation

Notepad++ plugin for Lua scripting capabilities

• Host: GitHub
• URL: https://github.com/dail8859/LuaScript
• Owner: dail8859
• License: gpl-2.0
• Created: 2016-01-19T21:27:32.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-02-01T16:37:52.000Z (over 1 year ago)
• Last Synced: 2025-04-02T01:11:10.928Z (7 months ago)
• Topics: lua, notepad-plus-plus, plugin
• Language: C
• Homepage: https://dail8859.github.io/LuaScript/
• Size: 1.19 MB
• Stars: 116
• Watchers: 9
• Forks: 23
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# LuaScript

[![Build status](https://ci.appveyor.com/api/projects/status/lxmu20jgggdm0xl3?svg=true)](https://ci.appveyor.com/project/dail8859/luascript)

Notepad++ plugin for [Lua](http://www.lua.org/) scripting capabilities. This provides control over all of Scintilla's features and options with a light-weight, fully-functional programming language.

Major features include:

- Assign Lua functions to shortcut keys

- Register callback functions for events

- Full Lua 5.3 functionality

- Interactive console with auto-completion

- Requires no special permissions

## Getting Started

Install the plugin using the Notepad++ Plugin Admin, or you can manually download it from the [Release](https://github.com/dail8859/LuaScript/releases) page and extract the zip into your `plugins` folder.

#### Lua Console

LuaScript provides an interactive console for running Lua commands. This can be shown by `Plugins > LuaScript > Show Console`.

#### Startup Script

LuaScript looks for the `\plugins\config\startup.lua` file and automatically runs it on Notepad++ startup. You can easily edit this file via `Plugins > LuaScript > Edit Startup Script`. You can include any commands you want to immediately execute on program startup, as well as register any additional shortcuts or callbacks.

#### Registering New Shortcuts

New functions can be added as shortcuts by using [AddShortcut](https://dail8859.github.io/LuaScript/classes/Notepad.html#Notepad.AddShortcut). The new menu items are listed under the `Plugins > LuaScript` menu. For example [this script](https://dail8859.github.io/LuaScript/examples/visualstudiolinecopy.lua.html) adds 2 new menu items.

#### Registering Callback Functions

Scripts can also register functions to be called when certain events occur, such as a file being opened, text being modified, etc. Each callback provides a different set of parameters. See the documentation for [callbacks](https://dail8859.github.io/LuaScript/topics/callbacks.md.html) to see the entire list of possible events and parameters provided.

## Documentation

The full API documentation can be found [here](http://dail8859.github.io/LuaScript/). Also be sure to check out the [examples](/examples/) directory.

## Development

The code has been developed using Visual Studio 2019. To compile the code:

1. Open the `LuaScript.sln` file

1. Press `F7` and that's it!

For convenience, Visual Studio automatically copies the DLL into the Notepad++ plugin directory. 

## License

This code is released under the [GNU General Public License version 2](http://www.gnu.org/licenses/gpl-2.0.txt).

#### Thanks

Special thanks to the [PythonScript](https://github.com/bruderstein/PythonScript) plugin and [SciTE](http://www.scintilla.org/SciTE.html).