From OpenSimulator
m (added some links) |
(added install instructions for the new svn version) |
||
Line 6: | Line 6: | ||
===About=== | ===About=== | ||
+ | WiXTD is a BSD-licensed PHP5-webportal/framework, that is tightly connected to the OpenSim database. It's purpose is to: | ||
+ | * simplify access to OpenSim | ||
+ | * allow non-tech personal to operate OpenSim | ||
+ | * Extend in-world content and functionality to the web | ||
+ | * Extend web-information to in-world objects | ||
− | WiXTD is | + | The idea behind WiXTD is to have a basic framework, on which two seperate applications will be build. One for casual purposes, and another one for e-learning purposes. WiXTD 0.1 already had it's first release, and is marked as pre-alpha code atm, there are some technical decisions for the long run, like: |
+ | * Using maintained PEAR packages for basic functionality, instead of custom written code | ||
+ | * Adding a Database abstraction layer(MDB2), to support MSSQL and PostgreSQL | ||
+ | * Make heavy use of jQuery | ||
− | + | Functionality in version 0.1 will be frozen to the current toolset, which is: | |
+ | * Registration(mail,instant) | ||
+ | * Stock avatar selection on registration, stock avatar duping/editing | ||
+ | * News section | ||
+ | * Static pages(html/iframe wrapper) | ||
+ | * Profile management | ||
+ | * Menu management | ||
+ | * Hypergrid Link management | ||
+ | * DB to XML Regionloader based on detected ip/port | ||
+ | * DB to XML Hypergrid linkloader for the grid | ||
+ | * Simulator control | ||
+ | * Merged ACP/Frontend | ||
+ | * Settings control | ||
+ | * OpenLayers mapcontrol, basic overlay, PHPCli TMS Grid MapTiler | ||
− | + | ===Installation=== | |
+ | There is a preliminary install script for wixtd now, which does an environment check, writes the database, and gives additional information how to get WiXTD running. The sql contains also modrex specific tables, which are for testing. These are not used normally, but can be switched on from the settings menu. Please install wixtd in a seperate database, apart from opensim. Follow these steps to get it running: | ||
+ | |||
+ | * Make sure you have PHP5, CURL, XMLRPC and imagick with JP2-support(requires jasper, and imagemagick with jp2-support) | ||
+ | * Copy wixtd from svn in the Apache's documentroot | ||
+ | svn checkout http://forge.opensimulator.org/svn/wixtd/trunk /var/www | ||
+ | * Run the installation script, by pointing your browser to: | ||
+ | http://foobar.org/install/install.php | ||
+ | * Follow the instructions in the script | ||
+ | * Log in and customize your wixtd | ||
+ | |||
+ | ===Manual=== | ||
+ | |||
+ | ====Micro's==== | ||
+ | Micro's are mini-components that have a small set of functionality, which can be accessed apart from the webportal. The current micro's are: | ||
+ | Splash screen in the viewer. Setup in Gridinfo | ||
http://mygrid.org/index.php?mcr=splash | http://mygrid.org/index.php?mcr=splash | ||
− | + | CLI script that generates maptiles from the region/simulator tables | |
− | + | php /my/webdir/index.php tiler | |
− | + | Currency handler. Will be used for karma | |
− | + | ||
− | + | ||
http://mygrid.org/index.php?mcr=currency.php | http://mygrid.org/index.php?mcr=currency.php | ||
− | + | Automated regionloading. Used by the webloader | |
− | + | ||
http://mygrid.org/index.php?mcr=sim2xml | http://mygrid.org/index.php?mcr=sim2xml | ||
+ | Automated HyperGrid linkloader | ||
+ | http://mygrid.org/index.php?mcr=sim2xml&ctr=hgl | ||
+ | Shows an asset-blob as an image. | ||
+ | http://mygrid.org/index.php?mcr=getAsset&uuid=643656-2343e344-434e32-3235ea | ||
+ | Used by an AJAX-call of region-data for Openlayers. Can be used for dynamic KML-layer generation as well | ||
+ | http://mygrid.org/index.php?mcr=map&lon=32&lat=64 | ||
+ | Anyway, you got the point. These are not at all times part of the webinterface, but can be used by OpenSimulator or an external API as well. Most data is returned as XML, but it's not yet consistent. This will be cleaned during the 0.1 phase as well... | ||
− | + | ===Template=== | |
− | + | If you want to change the template, it's best to copy the /tpl/osn folder to a custom /tpl/mynewtemplate folder. Change the theme in Settings accordingly. The mainstyling is in /tpl/mynewtemplate/style.css . Custom html layout is both in the template folder(general stuff for index layout), and in the /com/com.mycomponent/views directories. WiXTD uses the smarty engine for template parsing. | |
− | + | ||
− | + | ||
− | + | ||
− | === | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
<cleanpage title=hide cats=hide /> | <cleanpage title=hide cats=hide /> |
Revision as of 19:27, 27 January 2009
Contents |
The WiXTD Wiki page
Links
WiXTD on the forge
Running Development Version
About
WiXTD is a BSD-licensed PHP5-webportal/framework, that is tightly connected to the OpenSim database. It's purpose is to:
- simplify access to OpenSim
- allow non-tech personal to operate OpenSim
- Extend in-world content and functionality to the web
- Extend web-information to in-world objects
The idea behind WiXTD is to have a basic framework, on which two seperate applications will be build. One for casual purposes, and another one for e-learning purposes. WiXTD 0.1 already had it's first release, and is marked as pre-alpha code atm, there are some technical decisions for the long run, like:
- Using maintained PEAR packages for basic functionality, instead of custom written code
- Adding a Database abstraction layer(MDB2), to support MSSQL and PostgreSQL
- Make heavy use of jQuery
Functionality in version 0.1 will be frozen to the current toolset, which is:
- Registration(mail,instant)
- Stock avatar selection on registration, stock avatar duping/editing
- News section
- Static pages(html/iframe wrapper)
- Profile management
- Menu management
- Hypergrid Link management
- DB to XML Regionloader based on detected ip/port
- DB to XML Hypergrid linkloader for the grid
- Simulator control
- Merged ACP/Frontend
- Settings control
- OpenLayers mapcontrol, basic overlay, PHPCli TMS Grid MapTiler
Installation
There is a preliminary install script for wixtd now, which does an environment check, writes the database, and gives additional information how to get WiXTD running. The sql contains also modrex specific tables, which are for testing. These are not used normally, but can be switched on from the settings menu. Please install wixtd in a seperate database, apart from opensim. Follow these steps to get it running:
- Make sure you have PHP5, CURL, XMLRPC and imagick with JP2-support(requires jasper, and imagemagick with jp2-support)
- Copy wixtd from svn in the Apache's documentroot
svn checkout http://forge.opensimulator.org/svn/wixtd/trunk /var/www
- Run the installation script, by pointing your browser to:
http://foobar.org/install/install.php
- Follow the instructions in the script
- Log in and customize your wixtd
Manual
Micro's
Micro's are mini-components that have a small set of functionality, which can be accessed apart from the webportal. The current micro's are:
Splash screen in the viewer. Setup in Gridinfo http://mygrid.org/index.php?mcr=splash CLI script that generates maptiles from the region/simulator tables php /my/webdir/index.php tiler Currency handler. Will be used for karma http://mygrid.org/index.php?mcr=currency.php Automated regionloading. Used by the webloader http://mygrid.org/index.php?mcr=sim2xml Automated HyperGrid linkloader http://mygrid.org/index.php?mcr=sim2xml&ctr=hgl Shows an asset-blob as an image. http://mygrid.org/index.php?mcr=getAsset&uuid=643656-2343e344-434e32-3235ea Used by an AJAX-call of region-data for Openlayers. Can be used for dynamic KML-layer generation as well http://mygrid.org/index.php?mcr=map&lon=32&lat=64
Anyway, you got the point. These are not at all times part of the webinterface, but can be used by OpenSimulator or an external API as well. Most data is returned as XML, but it's not yet consistent. This will be cleaned during the 0.1 phase as well...
Template
If you want to change the template, it's best to copy the /tpl/osn folder to a custom /tpl/mynewtemplate folder. Change the theme in Settings accordingly. The mainstyling is in /tpl/mynewtemplate/style.css . Custom html layout is both in the template folder(general stuff for index layout), and in the /com/com.mycomponent/views directories. WiXTD uses the smarty engine for template parsing. UNIQ5cccf10d78b8978b-cleanpage-00000000-QINU