diff options
Diffstat (limited to '')
-rw-r--r-- | README.md | 117 |
1 files changed, 117 insertions, 0 deletions
@@ -7,3 +7,120 @@ server that works with Second Life viewers. | |||
7 | See doc/index.html for details. INSTALL.md for installation | 7 | See doc/index.html for details. INSTALL.md for installation |
8 | instructions. Differences.txt for the differences between OpenSim and | 8 | instructions. Differences.txt for the differences between OpenSim and |
9 | opensim-SC. coderDocs/ for the coder level documentation. | 9 | opensim-SC. coderDocs/ for the coder level documentation. |
10 | |||
11 | |||
12 | Welcome to OpenSimulator (OpenSim for short)! | ||
13 | |||
14 | # Overview | ||
15 | |||
16 | OpenSim is a BSD Licensed Open Source project to develop a functioning | ||
17 | virtual worlds server platform capable of supporting multiple clients | ||
18 | and servers in a heterogeneous grid structure. OpenSim is written in | ||
19 | C#, and can run under Mono or the Microsoft .NET runtimes. | ||
20 | |||
21 | This is considered an alpha release. Some stuff works, a lot doesn't. | ||
22 | If it breaks, you get to keep *both* pieces. | ||
23 | |||
24 | # Compiling OpenSim | ||
25 | |||
26 | Please see BUILDING.md if you downloaded a source distribution and | ||
27 | need to build OpenSim before running it. | ||
28 | |||
29 | # Running OpenSim on Windows | ||
30 | |||
31 | You will need .NET 4.0 for versions up to 0.9.0.1 and .NET 4.6 for others. | ||
32 | |||
33 | We recommend that you run OpenSim from a command prompt on Windows in order | ||
34 | to capture any errors. | ||
35 | |||
36 | To run OpenSim from a command prompt | ||
37 | |||
38 | * cd to the bin/ directory where you unpacked OpenSim | ||
39 | * review and change configuration files (.ini) for your needs. see the "Configuring OpenSim" section | ||
40 | * run OpenSim.exe or opensim32.exe for small regions | ||
41 | |||
42 | |||
43 | # Running OpenSim on Linux | ||
44 | |||
45 | You will need Mono >= 2.10.8.1 up to version 0.9.0.1 and mono > 5.0 on others. On some Linux distributions you | ||
46 | may need to install additional packages. See http://opensimulator.org/wiki/Dependencies | ||
47 | for more information. | ||
48 | |||
49 | To run OpenSim, from the unpacked distribution type: | ||
50 | |||
51 | * cd bin | ||
52 | * review and change configuration files (.ini) for your needs. see the "Configuring OpenSim" section | ||
53 | * run ./opensim.sh | ||
54 | |||
55 | |||
56 | # Configuring OpenSim | ||
57 | |||
58 | When OpenSim starts for the first time, you will be prompted with a | ||
59 | series of questions that look something like: | ||
60 | |||
61 | [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]: | ||
62 | |||
63 | For all the options except simulator name, you can safely hit enter to accept | ||
64 | the default if you want to connect using a client on the same machine or over | ||
65 | your local network. | ||
66 | |||
67 | You will then be asked "Do you wish to join an existing estate?". If you're | ||
68 | starting OpenSim for the first time then answer no (which is the default) and | ||
69 | provide an estate name. | ||
70 | |||
71 | Shortly afterwards, you will then be asked to enter an estate owner first name, | ||
72 | last name, password and e-mail (which can be left blank). Do not forget these | ||
73 | details, since initially only this account will be able to manage your region | ||
74 | in-world. You can also use these details to perform your first login. | ||
75 | |||
76 | Once you are presented with a prompt that looks like: | ||
77 | |||
78 | Region (My region name) # | ||
79 | |||
80 | You have successfully started OpenSim. | ||
81 | |||
82 | If you want to create another user account to login rather than the estate | ||
83 | account, then type "create user" on the OpenSim console and follow the prompts. | ||
84 | |||
85 | Helpful resources: | ||
86 | * http://opensimulator.org/wiki/Configuration | ||
87 | * http://opensimulator.org/wiki/Configuring_Regions | ||
88 | |||
89 | # Connecting to your OpenSim | ||
90 | |||
91 | By default your sim will be available for login on port 9000. You can login by | ||
92 | adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life | ||
93 | (e.g. in the Target: box of the client icon properties on Windows). You can | ||
94 | also login using the network IP address of the machine running OpenSim (e.g. | ||
95 | http://192.168.1.2:9000) | ||
96 | |||
97 | To login, use the avatar details that you gave for your estate ownership or the | ||
98 | one you set up using the "create user" command. | ||
99 | |||
100 | # Bug reports | ||
101 | |||
102 | In the very likely event of bugs biting you (err, your OpenSim) we | ||
103 | encourage you to see whether the problem has already been reported on | ||
104 | the [OpenSim mantis system](http://opensimulator.org/mantis/main_page.php). | ||
105 | |||
106 | If your bug has already been reported, you might want to add to the | ||
107 | bug description and supply additional information. | ||
108 | |||
109 | If your bug has not been reported yet, file a bug report ("opening a | ||
110 | mantis"). Useful information to include: | ||
111 | * description of what went wrong | ||
112 | * stack trace | ||
113 | * OpenSim.log (attach as file) | ||
114 | * OpenSim.ini (attach as file) | ||
115 | * if running under mono: run OpenSim.exe with the "--debug" flag: | ||
116 | |||
117 | mono --debug OpenSim.exe | ||
118 | |||
119 | # More Information on OpenSim | ||
120 | |||
121 | More extensive information on building, running, and configuring | ||
122 | OpenSim, as well as how to report bugs, and participate in the OpenSim | ||
123 | project can always be found at http://opensimulator.org. | ||
124 | |||
125 | Thanks for trying OpenSim, we hope it is a pleasant experience. | ||
126 | |||