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