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