LSLForge

An LSL Script Editor/compiler for Second Life's Scripting Language.

LSLForge is a fork of the popular LSLPlus editing evironment, to provide Linden Scripting Language (LSL) support in Eclipse.

Fork's Purpose

raysilent's fork is to maintain latest LSL definitions for functions and constants, fix bugs, as well as keep Eclipse Plugin Update Site up-to-date. After the tests are finished, the repo is merged into elnewfie's original one.

News (newest first)

• 0.1.9.7 (work in progress)
  • Windows & Mac executables only at this moment. Linux will have an older version of exectuable that is not supporting any new features or bug fixes.
  • Fixed bugs (Thanks @PellSmit))
  • New functions and constants:
    • llGetDayLength
    • llGetDayOffset
    • llGetMoonDirection
    • llGetMoonRotation
    • llGetRegionDayLength
    • llGetRegionDayOffset
    • llGetRegionMoonDirection
    • llGetRegionMoonRotation
    • llGetRegionSunDirection
    • llGetRegionSunRotation
    • llGetSunRotation
    • llReplaceAgentEnvironment
    • llSetAgentEnvironment
    • llTargetedEmail and its consants:
      • TARGETED_EMAIL_ROOT_CREATOR
      • TARGETED_EMAIL_OBJECT_OWNER
    • ENV_NOT_EXPERIENCE
    • ENV_NO_EXPERIENCE_PERMISSION
    • ENV_NO_ENVIRONMENT
    • ENV_INVALID_AGENT
    • ENV_NO_EXPERIENCE_LAND
    • ENV_VALIDATION_FAIL
    • ENV_NO_EXPERIENCE_LAND
    • ENV_THROTTLE
    • ENVIRONMENT_DAYINFO
    • INVENTORY_SETTING
    • SKY_CLOUD_TEXTURE
    • SKY_MOON_TEXTURE
    • SKY_SUN_TEXTURE
    • WATER_NORMAL_TEXTURE
    • (Bakes on Mesh related):
      • IMG_USE_BAKED_HEAD
      • IMG_USE_BAKED_UPPER
      • IMG_USE_BAKED_LOWER
      • IMG_USE_BAKED_EYES
      • IMG_USE_BAKED_SKIRT
      • IMG_USE_BAKED_HAIR
      • IMG_USE_BAKED_LEFTARM
      • IMG_USE_BAKED_LEFTLEG
      • IMG_USE_BAKED_AUX1
      • IMG_USE_BAKED_AUX2
      • IMG_USE_BAKED_AUX3
• 2018-09-16 LSLForge 0.1.9.6 (Windows, Linux (Thanks @Trapez), Mac (Thanks @PellSmit))
  • Animesh Functions and Constants:
    • llStartObjectAnimation(string anim);
    • llStopObjectAnimation(string anim);
    • list llGetObjectAnimationNames();
    • integer OBJECT_CREATION_TIME = 36;
    • integer OBJECT_SELECT_COUNT = 37;
    • integer OBJECT_SIT_COUNT = 38;
• 2018-09-14 LSLForge 0.1.9.5 (Windows, Linux (Thanks @Trapez), Mac (Thanks @PellSmit))
  • Experimental hot deploy of the newly selected native executable
  • "Generated" comment at the end of *.lsl file (easier to check what was copy-pasted) (Windows only)
• 2018-09-10 LSLForge 0.1.9.4 (Windows, Mac Only)
  • Fixed Tuple*.java disappearance (Thanks @PellSmit)
  • Upgraded Haskell (Thanks @simon-nicholls)
  • HTTP_USER_AGENT
  • OBJECT_RENDER_WEIGHT
  • key llName2Key(string name)
  • key llRequestUserKey(string name)
• 2017-02-10 LSLForge 0.1.9.3 (Windows, Linux (Thanks @Trapez), Mac (Thanks @PellSmit))
  • ATTACH_FACE_TONGUE misspelled
• 2017-01-07 LSLForge 0.1.9.2 (Windows, Linux (Thanks @Trapez), Mac (Thanks @PellSmit))
  • OBJECT_ATTACHED_SLOTS_AVAILABLE
  • llGetEnv("region_object_bonus") (in comments)
• 2016-11-13 LSLForge 0.1.9.1 (Windows, Linux (Thanks @Trapez), Mac (Thanks @PellSmit))
  • OBJECT_GROUP_TAG, OBJECT_TEMP_ATTACHED added
  • Bug fixes (Thanks @PellSmit):
    • #35 (negative out of range index)
    • #6 (backslash in string)
    • #26 (multiline string bug)
  • Bug fix #37 (cannot Run -> Run as -> Launch in LSL Sim)
  • Bug fix some null pointer exceptions during recompiled
• 2016-11-08 LSLForge 0.1.9 (Windows, Linux, Mac)
  • JSON_APPEND, CLICK_ACTION_ZOOM added
• 2016-10-22 LSLForge 0.1.8 (Windows only)
  • XP_ERROR_REQUEST_PERM_TIMEOUT missing added
• 2016-10-20 LSLForge 0.1.7 (Windows only)

Description

LSLForge is a plugin for the Eclipse platform. The plugin allows editing, "compiling" (gathering code included in modules), executing, and unit testing your Second Life® Linden Scripting Language (LSL) code.

Because it is an Eclipse plugin, when you use LSL Plus you can take advantage of many of the useful features of Eclipse. Integrated support of a source code control system such as Git, CVS and Subversion comes for "free", and there are many other features -- task list management, integration with bug tracking tools, etc. You will of course need to make sure you get the appropriate plugins to use these features.

Second Life® Group

The official group for LSLForge Editor tool is LSLForge Users. General announcements, questions and answers.

Installing

• Java 8 JDK is currently used for generating the plugin. You may find that you need to update to Java 8 or later in order to use the plugin.

Eclipse Plugin

All the latest Eclipse installations were found working:

• Eclipse IDE 2019‑06 R (4.12.0)
• Eclipse Photon (4.8.0)
• Eclipse Oxygen

NOTE: Oomph seems to restore LSLForge native setting despite attempts to overwrite the field. The only workaround for now is to check [X] Skip automatic task execution at startup time under Oomph > Setup Tasks in Preferences.

Platforms that used to work but not tested recently:

• Eclipse Neon (4.6.0)
• Eclipse Mars.2 (4.5.2)
• Eclipse Mars.1 (4.5.1)
• Eclipse Luna (4.4.0)
• Eclipse Juno RC2 (4.2.2)

How to Install

To install a plugin into Eclipse, choose Help > Install New Software. Click Add... and enter the link for location:

• For the tested and reported to be working releases use elnewfie's master repo:

  • https://raw.githubusercontent.com/elnewfie/lslforge/master/eclipse/

• For releases that are currently being tested use raysilent's master repo:

  • https://raw.githubusercontent.com/raysilent/lslforge/master/eclipse/

  (In case of bugs please report right to the https://github.com/raysilent/lslforge/ repo.)

• Alternatively you may switch to a development fork and try a specific version since 0.1.8 (including work in progress branches):

  • https://raw.githubusercontent.com/raysilent/lslforge/0.1.9.7/eclipse/ (Reinstall if you already have the version)
  • https://raw.githubusercontent.com/raysilent/lslforge/0.1.9.6/eclipse/
  • https://raw.githubusercontent.com/raysilent/lslforge/0.1.9.5/eclipse/
  • https://raw.githubusercontent.com/raysilent/lslforge/0.1.9.4/eclipse/
  • https://raw.githubusercontent.com/raysilent/lslforge/0.1.9.3/eclipse/
  • https://raw.githubusercontent.com/raysilent/lslforge/0.1.9.2/eclipse/
  • https://raw.githubusercontent.com/raysilent/lslforge/0.1.9.1/eclipse/
  • https://raw.githubusercontent.com/raysilent/lslforge/0.1.9/eclipse/
  • https://raw.githubusercontent.com/raysilent/lslforge/0.1.8/eclipse/

• For even older version, clone the whole repo and link your Eclipse to a particular folder under eclipse\archive.

If you don't see any items for installing, try to uncheck "Group items by category"

Run eclipse -clean to force it to forget cached downloads

Checkbox 2 items:

• "LSLForge"
• One of the native parts according to your environment.

Install, accept and restart Eclipse

Switch to LSLForge Perspective and create a new LSLForge Project

Known Issues

• *.lslp files compilation issues although everything is correct. It may happen when a lot of $import keywords are used and at some point the compiler gets stuck. What may help is:

  • Adding a fake *.lslm module along the project, it could be called Fake.lslm. Opening it and adding a space, then removing it and hitting Save will force the project to be recompiled
  • Forcing recompilation of a module that is referenced by *.lslp file by opening it, doing some fake change, and hitting Save

Tips & Tricks

Importing Modules

This demonstrates:

• How to use folders when importing modules (dot notation)
• How to import a module with a paramater

Modules/Debug.lslm :

$module (integer DEBUG)
// pragma inline
bug(string place, string message) {
  if (DEBUG) llOwnerSay("["+llGetScriptName()+"."+place+"]: "+message);
}

Script.lslp :

integer DEBUG=TRUE; // has to be a variable
$import Modules.Debug.lslm(DEBUG=DEBUG) de;

do() {
  debug("do()", "This is a call of 'bug' function from 'de' module");
}

Referencing Modules From Other Projects

Imagine you move Modules folder to a separate project called ModulesProject to use it from different other projects. In the main project that uses ModulesProject, place a checkmark along its name under Project settings > Project References.

ModulesProject directory tree becomes part of the project's tree. It will still be imported as $import Modules.Debug.lslm without any additions.

Native Executable Compilation Example

Requirements

To compile the native LSLForge binary, you must have the cross-platform Haskell Stack tool installed.

• Since LSLForge 0.1.9.7 Stack >= 1.11 is required.

Stack can then ensure that the correct compiler and dependencies for the project will be automatically downloaded and installed for you.

To install Stack, please visit the Stack Homepage and follow the instructions. It is likely that you can find a package available for many package managers e.g. chocolatey, homebrew and pacman, but check before installing that their stack version is up to date.

Configure Stack if desired:

• STACK_ROOT environment variable if you do not want stack files appear under C:\sr under Windows.
• To configure downloaded programs location, open stack's root config.yaml and add a line local-programs-path: <path> with the path desired, after that commands like stack ghci will download files right into that folder
• To configure where stack install will place the files, add the following line to config.yaml: local-bin-path: <path> with the path desired. This folder may be added to the PATH environment variable. (The reminder will be given after stack install copies the file there).

Compiling Haskell native LSLForge binary

In a terminal, change directory to the project's lslforge/haskell subdirectory, and enter stack install to build and install the LSLForge binary.

You will need to enter stack setup beforehand, if you have freshly installed Stack, or don't have the relevant compiler already set up. Stack will tell you if you need to run this additional step.

Post-compilation

If your "install" was successful, an executable will appear at %APPDATA%\local\bin folder for Windows, or $HOME/.local/bin for other platforms (look at the message after install) - unless you changed the local-bin-path parameter in config.yaml to override default location.

Now you only need to specify this executable in Eclipse, Preferences > LSLForge settings.

If you enable Eclipse Error Log View, it will print out current version of the executable in use, as well as its actual location.

Eclipse should be restarted

Running tests

You can optionally run the LSLForge binary tests by executing stack test in the terminal, from the haskell subdirectory.

The tests require that the LSLFORGE_TEST_DATA environment variable be set for the terminal session, but for casual needs you can also use LSLFORGE_TEST_DATA=../testing/data stack test.

Eclipse Plug-in Compilation

• Change version numbers if necessary

• Move existing plugin files from eclipse\ to eclipse\archive\x.x.x\.

• Eclipse for RCP and RAP Developers - Using Luna SR2

  • Use empty workspace
  • Import projects from lslforge\eclipse\ (without copying)
  • Go to update-site's project folder and run clean.bat to delete previously generated files
  • Open update-site\site.xml click the tree element and then Build All

    • Generated files are:

      • features
      • plugins
      • artifacts.jar
      • content.jar

    • Move generated files to eclipse\

    • Copy index.html (static file) to eclipse\

• Test generated update site with a fresh installation of Eclipse using Local path for plugin:

  • Switch Eclipse for RCP and RAP Developers workspace to a newly made
  • Help > Install New Software
    • Add.. update site, providing Local location of eclipse folder as a source
    • Install newly made LSLForge plugin
  • Restart Eclipse
  • Switch Perspective to LSLForge
    • Create new LSLForge Project
    • Create *.lslp files and see Error Log View