Difference between revisions of "FURWARE text"

Revision as of 17:14, 6 July 2013

Warning: This page is currently under construction and may not be complete yet.

Overview

FURWARE text is a script for displaying text on prims using textures. It is intended to be integrated in your objects in which it will be controlled by your own scripts.

FURWARE text is not a ready-made display board but is intented for scripters who wish to integrate it in their own creations.

The script was proprietary from 2010 to July 2013 until I (Ochi Wolfe) have decided to make it open source under the MIT license. It is my first attempt to make a fully open sourced product in Second Life.

Features

Open source (MIT license)
Only one script for a whole group ("sets") of displays
Formatting (color, alpha, alignment, wrapping, trimming, font, borders)
Mesh prims with 1 to 8 chars, only occupying 0.5 prims each
Virtual text boxes to position text arbitrarily
Style templates for encapsulating multiple style settings

How to obtain the script

You can obtain a complete package containing the script, the display creator, display meshes and font textures at the Marketplace.

For developers and interested users, I have also set up a github account for the core scripts.

Documentation

Please see the following subpages for the user's manual and developer documentation:

First steps & extensive tutorial

Short reference & version history

Developer documentation

The "old" v2.0-Beta1 documentation is also available on the FURWARE website (a German version is also available there).

To do

There are still some things to do for the conversion into an open source project:

Check the documentation for errors.
Migrate the German documentation to the SL Wiki.
Create developer documentation explaining concepts and ideas of the script.
Improve the font overview in the manual; make UUIDs copyable.
I think there is a small bug in one of the images in the tutorial, I'll have to check that.
Publish texture specifications.
Publish mesh specifications.
Add more useful comments to the scripts themselves.
Clean up the scripts of the display creator and element initializer.
Migrate internal bug tracker, possibly to github.
Update the "FURWARE info board" to use the open source version of text.
Make more open source example (controller) scripts.

@@ Line 1: / Line 1: @@
-{{KBwarning|This page is currently under construction. The script described here is currently in the course of being re-released as open source. Please bear with me while I convert my old documentation (and the product itself). Please do not edit this page yet.}}
+{{KBwarning|This page is currently under construction and may not be complete yet.}}
@@ Line 21: / Line 21: @@
 == How to obtain the script ==
-(To be released soon)
+You can obtain a complete package containing the script, the display creator, display meshes and font textures at [http://marketplace.secondlife.com/p/FURWARE-text-v20-open-source-Text-on-prims-with-a-single-script/141379 the Marketplace].
+For developers and interested users, I have also set up a [http://github.com/furware/text github] account for the core scripts.
 == Documentation ==
@@ Line 32: / Line 34: @@
 [[FURWARE_text/Developers|Developer documentation]]
+The "old" v2.0-Beta1 documentation is also available on the [http://furware.de/products/text/ FURWARE website] (a German version is also available there).
+== To do ==
+There are still some things to do for the conversion into an open source project:
+* Check the documentation for errors.
+* Migrate the German documentation to the SL Wiki.
+* Create developer documentation explaining concepts and ideas of the script.
+* Improve the font overview in the manual; make UUIDs copyable.
+* I think there is a small bug in one of the images in the tutorial, I'll have to check that.
+* Publish texture specifications.
+* Publish mesh specifications.
+* Add more useful comments to the scripts themselves.
+* Clean up the scripts of the display creator and element initializer.
+* Migrate internal bug tracker, possibly to github.
+* Update the "FURWARE info board" to use the open source version of text.
+* Make more open source example (controller) scripts.