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