README.txt

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name)
 
Line 4: Line 4:
 
This page is for putting the translations in each languages of README.txt.
 
This page is for putting the translations in each languages of README.txt.
  
Note that the most reliable one is the copy in OpenSim packages.
+
Note that the most reliable one is the copy in OpenSimulator packages.
  
 
  Welcome to OpenSim!
 
  Welcome to OpenSim!
Line 12: Line 12:
 
  ==================
 
  ==================
 
   
 
   
  OpenSim is a BSD Licensed Open Source project to develop a functioning
+
  OpenSimulator is a BSD Licensed Open Source project to develop a functioning
 
  virtual worlds server platform capable of supporting multiple clients
 
  virtual worlds server platform capable of supporting multiple clients
  and servers in a heterogeneous grid structure. OpenSim is written in
+
  and servers in a heterogeneous grid structure. OpenSimulator is written in
 
  C#, and can run under Mono or the Microsoft .NET runtimes.
 
  C#, and can run under Mono or the Microsoft .NET runtimes.
 
   
 
   
Line 21: Line 21:
 
   
 
   
 
  =========================
 
  =========================
  === Compiling OpenSim ===
+
  === Compiling OpenSimulator ===
 
  =========================
 
  =========================
 
   
 
   
 
  Please see BUILDING.txt if you downloaded a source distribution and  
 
  Please see BUILDING.txt if you downloaded a source distribution and  
  need to build OpenSim before running it.
+
  need to build OpenSimulator before running it.
 
   
 
   
 
  ==================================
 
  ==================================
  === Running OpenSim on Windows ===
+
  === Running OpenSimulator on Windows ===
 
  ==================================
 
  ==================================
 
   
 
   
  We recommend that you run OpenSim from a command prompt on Windows in order
+
  We recommend that you run OpenSimulator from a command prompt on Windows in order
 
  to capture any errors.
 
  to capture any errors.
 
   
 
   
  To run OpenSim from a command prompt
+
  To run OpenSimulator from a command prompt
 
   
 
   
  * cd to the bin/ directory where you unpacked OpenSim
+
  * cd to the bin/ directory where you unpacked OpenSimulator
 
  * run OpenSim.exe
 
  * run OpenSim.exe
 
   
 
   
Line 42: Line 42:
 
   
 
   
 
  ================================
 
  ================================
  === Running OpenSim on Linux ===
+
  === Running OpenSimulator on Linux ===
 
  ================================
 
  ================================
 
   
 
   
  You will need Mono >= 2.4.3 to run OpenSim.  On some Linux distributions you
+
  You will need Mono >= 2.4.3 to run OpenSimulator.  On some Linux distributions you
 
  may need to install additional packages.  See http://opensimulator.org/wiki/Dependencies
 
  may need to install additional packages.  See http://opensimulator.org/wiki/Dependencies
 
  for more information.
 
  for more information.
Line 57: Line 57:
 
   
 
   
 
  ===========================
 
  ===========================
  === Configuring OpenSim ===
+
  === Configuring OpenSimulator ===
 
  ===========================
 
  ===========================
 
   
 
   
  When OpenSim starts for the first time, you will be prompted with a
+
  When OpenSimulator starts for the first time, you will be prompted with a
 
  series of questions that look something like:
 
  series of questions that look something like:
 
   
 
   
Line 70: Line 70:
 
   
 
   
 
  You will then be asked "Do you wish to join an existing estate?".  If you're
 
  You will then be asked "Do you wish to join an existing estate?".  If you're
  starting OpenSim for the first time then answer no (which is the default) and
+
  starting OpenSimulator for the first time then answer no (which is the default) and
 
  provide an estate name.
 
  provide an estate name.
 
   
 
   
Line 82: Line 82:
 
   Region (My region name) #
 
   Region (My region name) #
 
   
 
   
  You have successfully started OpenSim.
+
  You have successfully started OpenSimulator.
 
   
 
   
 
  If you want to create another user account to login rather than the estate
 
  If you want to create another user account to login rather than the estate
  account, then type "create user" on the OpenSim console and follow the prompts.
+
  account, then type "create user" on the OpenSimulator console and follow the prompts.
 
   
 
   
 
  Helpful resources:
 
  Helpful resources:
Line 92: Line 92:
 
   
 
   
 
  ==================================
 
  ==================================
  === Connecting to your OpenSim ===
+
  === Connecting to your OpenSimulator ===
 
  ==================================
 
  ==================================
 
   
 
   
Line 98: Line 98:
 
  adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
 
  adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
 
  (e.g. in the Target: box of the client icon properties on Windows).  You can
 
  (e.g. in the Target: box of the client icon properties on Windows).  You can
  also login using the network IP address of the machine running OpenSim (e.g.
+
  also login using the network IP address of the machine running OpenSimulator (e.g.
 
  http://192.168.1.2:9000)
 
  http://192.168.1.2:9000)
 
   
 
   
Line 110: Line 110:
 
  In the very likely event of bugs biting you (err, your OpenSim) we
 
  In the very likely event of bugs biting you (err, your OpenSim) we
 
  encourage you to see whether the problem has already been reported on
 
  encourage you to see whether the problem has already been reported on
  the OpenSim mantis system. You can find the OpenSim mantis system at
+
  the OpenSimulator mantis system. You can find the OpenSimulator mantis system at
 
   
 
   
 
     http://opensimulator.org/mantis/main_page.php
 
     http://opensimulator.org/mantis/main_page.php
Line 128: Line 128:
 
   
 
   
 
  ===================================
 
  ===================================
  === More Information on OpenSim ===
+
  === More Information on OpenSimulator ===
 
  ===================================
 
  ===================================
 
   
 
   
 
  More extensive information on building, running, and configuring
 
  More extensive information on building, running, and configuring
  OpenSim, as well as how to report bugs, and participate in the OpenSim
+
  OpenSim, as well as how to report bugs, and participate in the OpenSimulator
 
  project can always be found at http://opensimulator.org.
 
  project can always be found at http://opensimulator.org.
 
   
 
   
 
  Thanks for trying OpenSim, we hope it is a pleasant experience.
 
  Thanks for trying OpenSim, we hope it is a pleasant experience.

Latest revision as of 23:55, 3 March 2012

This page is for putting the translations in each languages of README.txt.

Note that the most reliable one is the copy in OpenSimulator packages.

Welcome to OpenSim!

==================
==== OVERVIEW ====
==================

OpenSimulator is a BSD Licensed Open Source project to develop a functioning
virtual worlds server platform capable of supporting multiple clients
and servers in a heterogeneous grid structure. OpenSimulator is written in
C#, and can run under Mono or the Microsoft .NET runtimes.

This is considered an alpha release.  Some stuff works, a lot doesn't.
If it breaks, you get to keep *both* pieces.

=========================
=== Compiling OpenSimulator ===
=========================

Please see BUILDING.txt if you downloaded a source distribution and 
need to build OpenSimulator before running it.

==================================
=== Running OpenSimulator on Windows ===
==================================

We recommend that you run OpenSimulator from a command prompt on Windows in order
to capture any errors.

To run OpenSimulator from a command prompt

* cd to the bin/ directory where you unpacked OpenSimulator
* run OpenSim.exe

Now see the "Configuring OpenSim" section

================================
=== Running OpenSimulator on Linux ===
================================

You will need Mono >= 2.4.3 to run OpenSimulator.  On some Linux distributions you
may need to install additional packages.  See http://opensimulator.org/wiki/Dependencies
for more information.

To run OpenSim, from the unpacked distribution type:

* cd bin
* mono OpenSim.exe

Now see the "Configuring OpenSim" section

===========================
=== Configuring OpenSimulator ===
===========================

When OpenSimulator starts for the first time, you will be prompted with a
series of questions that look something like:

[09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:

For all the options except simulator name, you can safely hit enter to accept
the default if you want to connect using a client on the same machine or over
your local network.

You will then be asked "Do you wish to join an existing estate?".  If you're
starting OpenSimulator for the first time then answer no (which is the default) and
provide an estate name.

Shortly afterwards, you will then be asked to enter an estate owner first name,
last name, password and e-mail (which can be left blank).  Do not forget these
details, since initially only this account will be able to manage your region
in-world.  You can also use these details to perform your first login.

Once you are presented with a prompt that looks like:

  Region (My region name) #

You have successfully started OpenSimulator.

If you want to create another user account to login rather than the estate
account, then type "create user" on the OpenSimulator console and follow the prompts.

Helpful resources:
* http://opensimulator.org/wiki/Configuration
* http://opensimulator.org/wiki/Configuring_Regions

==================================
=== Connecting to your OpenSimulator ===
==================================

By default your sim will be available for login on port 9000.  You can login by
adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
(e.g. in the Target: box of the client icon properties on Windows).  You can
also login using the network IP address of the machine running OpenSimulator (e.g.
http://192.168.1.2:9000)

To login, use the avatar details that you gave for your estate ownership or the
one you set up using the "create user" command.

===================
=== Bug reports ===
===================

In the very likely event of bugs biting you (err, your OpenSim) we
encourage you to see whether the problem has already been reported on
the OpenSimulator mantis system. You can find the OpenSimulator mantis system at

   http://opensimulator.org/mantis/main_page.php

If your bug has already been reported, you might want to add to the
bug description and supply additional information.

If your bug has not been reported yet, file a bug report ("opening a
mantis"). Useful information to include:
* description of what went wrong
* stack trace
* OpenSim.log (attach as file)
* OpenSim.ini (attach as file)
* if running under mono: run OpenSim.exe with the "--debug" flag:

      mono --debug OpenSim.exe

===================================
=== More Information on OpenSimulator ===
===================================

More extensive information on building, running, and configuring
OpenSim, as well as how to report bugs, and participate in the OpenSimulator
project can always be found at http://opensimulator.org.

Thanks for trying OpenSim, we hope it is a pleasant experience.
Personal tools
General
About This Wiki