From 5e4d6cab00cb29cd088ab7b62ab13aff103b64cb Mon Sep 17 00:00:00 2001 From: onefang Date: Sun, 19 May 2019 21:24:15 +1000 Subject: Dump OpenSim 0.9.0.1 into it's own branch. --- README.md | 188 +++++++++++++++++++++++++------------------------------------- 1 file changed, 76 insertions(+), 112 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 12cba74..2aea328 100644 --- a/README.md +++ b/README.md @@ -1,152 +1,116 @@ -Use this to create a sim that links into Infinite Grid from Linux. +Welcome to OpenSim! -It's only been tested on Ubuntu 10.04, 11.04, 12.04, 16.04' as well as -Debian 8, YMMV. This is also a WIP, use it at your own risk. It's been -used to set up a few freshly installed Ubuntu servers though. +# Overview -The directory layout. ---------------------- +OpenSim 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. OpenSim is written in +C#, and can run under Mono or the Microsoft .NET runtimes. -The various directories are - +This is considered an alpha release. Some stuff works, a lot doesn't. +If it breaks, you get to keep *both* pieces. -.git Used by git for it's internal accounting, and the older versions. +# Compiling OpenSim -.nant Used by the nant build tool. +Please see BUILDING.md if you downloaded a source distribution and +need to build OpenSim before running it. -OpenSim OpenSim source code. +# Running OpenSim on Windows -Prebuild Used by the build system. +You will need .NET 4.0 installed to run OpenSimulator. -ThirdParty For third party OpenSim modules. +We recommend that you run OpenSim from a command prompt on Windows in order +to capture any errors. -addon-modules Also for third party modules. Don't ask me why there's two. +To run OpenSim from a command prompt -bin The OpenSim binaries, and other files. + * cd to the bin/ directory where you unpacked OpenSim + * run OpenSim.exe -doc Supposedly for documentation, which I wish OpenSim devs would write some. +Now see the "Configuring OpenSim" section -scripts Various Linux scripts for managing OpenSim. +# Running OpenSim on Linux -share No idea really. +You will need Mono >= 2.10.8.1 to run OpenSimulator. On some Linux distributions you +may need to install additional packages. See http://opensimulator.org/wiki/Dependencies +for more information. -Also, the installation script moves the following directories to outside -of this main directory, they are all used for writing various things. -Makes it easy to upgrade, and separates them from actual executable -stuff. +To run OpenSim, from the unpacked distribution type: -AssetFiles Stores assets if running in grid mode. + * cd bin + * mono OpenSim.exe -backups All sim and inventory backups are stored here. +Now see the "Configuring OpenSim" section -caches Various cached things. +# Configuring OpenSim -config All your configurtion files. +When OpenSim starts for the first time, you will be prompted with a +series of questions that look something like: -db If you are not using MySQL, your data lives here. + [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]: -logs Log files get stored here. +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 OpenSim for the first time then answer no (which is the default) and +provide an estate name. -Follow these steps. -------------------- +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. -Go to - +Once you are presented with a prompt that looks like: -https://www.infinitegrid.org/drupal/content/How_to_link_your_OpenSim_region_to_Infinite_Grid_LinuxMySQL + Region (My region name) # -and follow the directions to create an admin user account. You can skip -that bit if you already have a suitable user with sudo access. +You have successfully started OpenSim. -Note that these scripts pretty much follow that above wiki description, -with some exceptions. The configuration information per sim has been -rearranged so that there is only ONE copy of the OpenSim installation. +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. -Next you need to figure out what password you want to use for OpenSims -access to the database. We will call this "DatabasePassword". Run the -following script, from inside the OpenSim directory - +Helpful resources: + * http://opensimulator.org/wiki/Configuration + * http://opensimulator.org/wiki/Configuring_Regions -./InstallItAll.sh DatabasePassword +# Connecting to your OpenSim -This will do most of the work for you, except for creating sims. There -is a final step that needs to be done manually for now. Edit -/etc/rc.local, make sure it has the following line in it somewhere, -probably at the end - +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 OpenSim (e.g. +http://192.168.1.2:9000) -/opt/opensim/current/scripts/fix_var_run.sh +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 -Creating sims. --------------- +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 [OpenSim mantis system](http://opensimulator.org/mantis/main_page.php). -A separate script is here for sim creation, you can use it to create many -sims. You will need - +If your bug has already been reported, you might want to add to the +bug description and supply additional information. -Your host name, or it could be your IP, we will use "sims.example.net". +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: -A name for your sim, we will use "My new sim". It should be unique on -the grid. + mono --debug OpenSim.exe -A location for your sim, we will use "1234,5678". You can use the -Infinite Grid web based map to poke around and find a good location. -Choose an empty spot. +# More Information on OpenSim -Once you have all that information sorted out, run this script from the -installed scripts directory - +More extensive information on building, running, and configuring +OpenSim, as well as how to report bugs, and participate in the OpenSim +project can always be found at http://opensimulator.org. -./create_sim.sh "My new sim" "1234,5678" "sims.example.net" +Thanks for trying OpenSim, we hope it is a pleasant experience. -Or this if you want to override the detected IP address - - -./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" - -Also, you can create a varregion with something like - - -./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" 512 - -Note that the size has to be a multiple of 256, so 512, 768, 1024, etc. - -Running sims. -------------- - -Now you can go to /opt/opensim/config/sim01 and run the following script -to start it up - - -./start-sim - -You will see the screen console. You can run the screen console again by -running that command once more, or running the sim-console command. - -You can stop the sim with - - -./stop-sim - -You can backup the sim with - - -./backup-sim - - - -Finishing up. -------------- - -Once it's all tested, you can use this to finish things off (back in -the scripts directory) - - -./go_live.sh - -Which sets up the monit control file/s, though you should double check -it all, and you still have to do the basic configuration and enabling of -monit yourself. This is in case you already have monit set the way you -like. - - -NOTES - - -This attempts to use only one copy of the OS install for all sims. We -are running one instance of OS for each sim though, as this prevents one -sim crashing from bringing down the others. OS however really wants to -write data to directories within it's own bin directory. I'm not at all -certian if that data can be shared. For the same reason, so far I've -not been able to get to the point where we can make the OS directory -read only. This complicates things during upgrades. -- cgit v1.1