Lunar

A cross-platform (MacOS, Linux, Windows) script editor

• Customize your script api, auto-completion & goto-definition plugins.
• Currently supported: lua, python, cpp, octave, cocos2dx_lua, cocos2dx_js

Preparations

• Qt
• QScintilla

Download Qt5 and QScintilla 2.10.

Install Qt, add Qt compiler directory to environment variable.

Build steps

Build luaexec

1. Get Util project from Util: Cross-platform C++ library.

2. Run python3 install_build_tool_here.py. You would be ask Please input Util project dir:, then input Util absolute directory you justed cloned/downloaded above. Something like: /Users/XXX/projects/Util.

Build Qscintilla

1. cd QScintilla/Qt4Qt5

2. qmake qscintilla.pro

3. make

4. make install

Build Lunar

Run ./luaexec remake_lunar.lua.

If you already built it then made some changes and just want an incremental build, run ./luaexec make_lunar.lua.

When you add/remove an icon or add/remove a source file which need to regenerate Lunar.pro, you should always clear everything and start from the begginning, run ./luaexec clear_lunar.lua, and then ./luaexec remake_lunar.lua.

Release steps

On Linux and Windows

• Make a dir named Lunar, lets' call it LUNAR_HOME.
• Put all the files and folders in publish to LUNAR_HOME.
• Put luaexec and Lunar to LUNAR_HOME.

On windows extras (You can find all the dlls in Qt installation directory):

• Put libstdc++-6.dll(mingw), libgcc_s_dw2-1.dll(mingw), libwinpthread-1.dll(mingw), Qt5Core.dll, Qt5Gui.dll, Qt5PrintSupport.dll, Qt5Widgets.dll, qscintilla2_qt5.dll, icudt54, icuin54.dll, icuuc54.dll to LUNAR_HOME.
• Put qwindows.dll to LUNAR_HOME/platforms

On MacOS

• Run ./luaexec deploy_on_mac.lua on terminal to make Lunar.dmg

• In the making-dmg step, you'll need to give some information:

  • Please input libqscintilla2_qt5.13.dylib dir: You need to input the ibqscintilla2_qt5.13.dylib installed directory, something like /Users/XXX/programs/Qt5.7.1/5.7/clang_64/lib

  • Deploy as dmg? (y/n)

    • Type y for generating dmg. Then you got Lunar.dmg.
    • Type n for not generating dmg, then you only got a Lunar.app, you can run ./luaexec replace_current_lunar_on_mac.lua to replace /Applications/Lunar.app with this one. This is very useful when you want perform a quick-test after some modification and build.

Install Lunar

For Linux users, you should build Lunar following the Release steps.

For MacOS or Windows users, you can download installation-package from the following link:

Download Link

• MacOS

  • Install Lunar from Lunar.dmg to /Applications
  • Add export PATH=$PATH:/Applications/Lunar.app/Contents/MacOS to your environment. (Then you can start Lunar from your terminal in current directory by typing command luna)

• Windows

  • Just unzip lunar_win.zip
  • Add lunar_win directory to your environment PATH.

• Linux

  • After Lunar is built and everything in a folder, add the folder directory to environment: export PATH=$PATH:{LUNAR_HOME}

After installation, you should update plugins at once.

Update plugins

• Open Lunar from command line. (For Linux and Windows, input Lunar then press Enter. for MacOS input luna then press Enter)

• Open File Explorer with shortcut key CTRL (COMMAND on MacOS) + SHIFT + E, then CTRL (COMMAND on MacOS) + J open Context Menu. Select Tools/lunar/update_lunar_plugins to update packages (apis / assets / plugins / tools / luaexeclib / extension.lua) to the latest. (Make sure you have svn command line installed).

• When execute the update, you would be asked Are you sure to replace extension.lua which may change your current settings? (y/n).

  • Type y and click input button (or press Enter): you would use new extension.lua from the download. Your old extension.lua would be kept as extension_backup.lua if there is something you changed in your own extension.lua. For a new-install-user, just type y.

  • Type n and click input button (or press Enter): you would keep your old extension.lua. New-downloaded extension.lua would be saved as extension_latest.lua if there is a new version of extension.lua. If you made some changes to your extension.lua and want to keep the changes, select n to keep your old extension.lua, you can compare it with the newest one extension_latest.lua after update.