# OpenVerse Personal Server (ServGUI) Configuration
# 
# Tech docs for OpenVerse.
#
# Module Name		- Main Module
# Current Maintainter 	- vile <documentation@openverse.com> 
# Sourced By		- OpenHelp
#
# Portions Copyright (C) 1999 Bruce Gingery <bgingery@gtcs.com>
# OpenHelp Conversion Copyright (C) 1999 David Gale <cruise@openverse.org>
# For more information visit http://OpenVerse.org/
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,
# USA.

# OpenVerse Technical Help
# Converted from documentation written by Bruce Gingery
# <bgingery@gtcs.com>

proc pindex {} {
	global MV
	set MV(url.-2.1.what) "mailto:cruise@openverse.org"
	set MV(url.-2.2.what) "http://www.openverse.com/"
	set MV(url.-2.3.what) "http://www.openverse.com/plugins"
	set MV(url.-2.4.what) "mailto:bgingery@gtcs.com"
	set MV(url.-2.5.what) "http://export-ventures.com/tcltk.htm"
	set MV(url.-2.6.what) "http://www.openverse.com/objects.php3"
	set MV(url.-2.7.what) "mailto:villain@openverse.com"
	
openHelp "OpenVerse Personal Server Configuration" {

	<h2><fgr>OpenVerse
	Personal Server Configuration</fgr></h2>

	<i>Written by <URL_OpenWeb -2 7>Villain</URL_OpenWeb -2 7></i>

  This section contains information on confiruing your own OpenVerse server using the ServGUI tool within OpenVerse.

   1.	<SHLP_Overview><b>OverView</b></SHLP_Overview>
   2.	<SHLP_Start>Starting a Personal Server</SHLP_Start>
   3.	<SHLP_Ssettings>Server Settings</SHLP_Ssettings>
   4.	<SHLP_Sdirs>Server Directories</SHLP_Sdirs>

}}

proc SHLP_Overview {} {
openHelp "OpenVerse Personal Server Overview" {

		<fgb><h1>Overview</h1></fgb>

<b>Why a personal server?</b> 

Well there are many answers to this question. 
For instance a personal server allows for you to develop and test server objects, create a private room to host a personal meeting, start your own room, or possibly even a game (via server objects).

Wanna give it a spin? <SHLP_Start>Next</SHLP_Start>

<pindex>[Main Index]</pindex>

}}

proc SHLP_Start {} {
openHelp "Starting a Personal Server" {

		<fgb><h1>Getting Started</h1></fgb>

To start a personal server either hit alt+s in the main window or click the setup button and click the "Start Server" button.

You will then be presented with a window thst is titled "Personal OpenVerse Server", this means your server is running, and allows you to perform a few functions.

The buttons are as follows:

<b>Kill Server:</b> Shuts down your personal server.

<b>Server Settings:</b> Presents the Server Settings window, which allows you to configure your personal server.

<b>Announce Server:</b> Sends a link to your server to everyone in the room you are currently in.

<b>Connect:</b> Connects your client to the server you have started.

<b>Clear Log:</b> Empties the personal server log window.

<b>Users Connected</b> Displays how many users are on your server. (this is not a pushable button)

From here you should proceed on to <SHLP_Ssettings>Server Settings</SHLP_Ssettings>

<pindex>[Main Index]</pindex>

}}

proc SHLP_Ssettings {} {
openHelp "Personal Server Settings" {

		<fgb><h1>Personal Server
		Settings</h1></fgb>

<b>Room Name:</b> Title that will appear both at the top of the client window, and on the ort link (if registered).

<b>Max Av Size:</b> Allows you to set the maximum image size <i>Width</i> and <i>Height</i> that a user can have in your room.

<b>Room Image:</b> The background image for your room. This should be a 640x480 gif. <b>NOTE! ONLY GIF FILES ARE SUPPORTED!</b>

<b>Max Users:</b> Allows you to set a maximum number of users that can connect to your server at the same time. Set this to 0 (zero) to have no limit.

<b>Server Port</b> This is the port that your server will accept connections on (7000 by default).

<b>Max Multiple Logins</b> This setting allows you to choose how many connections may be made from the same ip. (usually the same user) 

<b>Max Msg Len:</b> This allows you to set the maximum ammount of characters (such as letters or numbers) that may be sent in one message.

<b>Allow Push</b> Check or uncheck this box to choose wether or not you want to allow the /push command on your server.

<fgb><h2>ORT Settings</h2></fgb>

The following settings allow you to register with the ORT and provide information about your server to all those who use the ORT.

<b>Rating:</b> Rate the content of your server (consider this as you would rate it if it were a movie).

<b>Register With ORT</b> Check this box to register your server with the ORT, and uncheck it to do the opposite.

<b>ORT Server:</b> Give an IP Address and port for the ORT Server you wish to register with. There is currently only one ort, with the host <i>ort.openverse.com</i> and the port <i>4200</i>

<b>ORT Username:</b> Set a unique username for dealing with the ORT.

<b>ORT Password:</b> Set a unique password for dealing with the ORT.

<b>ORT Location:</b> Set <b>X</b> and <b>Y</b> cooridantes for the ORT to be located on the screen when it logs in.

<b>Serv Description:</b> Enter information about your server here IE: My personal server. Come in and Join the fun!

<b>Serv Location:</b> Enter the <i>State</i> and <i>Country</i> the server resides in.

<b>Serv Admin:</b>Enter the <i>Name</i> and <i>Email</i> of the servers adminstrator (you).

<b>Serv Website:</b> Enter the url for the servers webpage (<i>your webpage</i>)

After configuring these settings Hit <b>Save/Apply</b> to enact the changes, or <b>cancel</b> to undo everything you have typed.

At this point you may wish to learn more about <SHLP_Sdirs>Server Directories</SHLP_Sdirs>.

<pindex>[Main Index]</pindex>
}}

proc SHLP_Sdirs {} {
openHelp "OpenVerse Personal Server - Server Directories" {

	<fgb><h1>Server Directories</h1></fgb>

The following directories contain files used for your personal server:

<b>rooms:</b> Should contain the image you use for your server's background.

<b>simages:</b> Contains the images used by all the users that have connected to your server.

<b>images:</b> Contains the images for your objects (also contains your avatars)

<b>sobjects:</b> Should contain all objects you wish to utilize on your
server. See <URL_OpenWeb -2 6>http://www.openverse.com/objects.php3</URL_OpenWeb -2 6>

<pindex>[Main Index]</pindex>
}}


pindex