search

elnewfie / lslforge

Automatically exported from code.google.com/p/lslforge
24 stars 13 forks source link

readme

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 Purpose

This fork is to maintain LSL definitions for functions and constants, as well as maintaining Eclipse Plugin Update Site.

News (newest first)

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

Eclipse Plugin

All the latest Eclipse installations were found working:

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:

How to Install

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

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:

Install, accept and restart Eclipse

Switch to LSLForge Perspective and create a new LSLForge Project

Known Issues

Tips & Tricks

Importing Modules

This demonstrates:

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. 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 folder if necessary:

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 confif.yaml to override default location

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

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.