README.txt 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. Welcome to OpenSim!
  2. == OVERVIEW ==
  3. OpenSim is a BSD Licensed Open Source project to develop a functioning
  4. virtual worlds server platform capable of supporting multiple clients
  5. and servers in a heterogeneous grid structure. OpenSim is written in
  6. C#, and can run under Mono or the Microsoft .NET runtimes.
  7. This is considered an alpha release. Some stuff works, a lot doesn't.
  8. If it breaks, you get to keep *both* pieces.
  9. == Installation on Windows ==
  10. Prereqs:
  11. * runprebuild.bat
  12. * Load OpenSim.sln into Visual Studio .NET and build the solution.
  13. * chdir bin
  14. * edit OpenSim.ini and appropriate files in bin/config-include
  15. * OpenSim.exe
  16. Helpful resources:
  17. * http://opensimulator.org/wiki/Build_Instructions
  18. See configuring OpenSim
  19. == Installation on Linux ==
  20. Prereqs:
  21. * Mono >= 2.4.2
  22. * Nant >= 0.86 beta 1 (if building with the .NET framework on Windows), 0.85 (if building with the mono framework)
  23. * sqlite3 or mysql 5.x (you'll need a backend database)
  24. From the distribution type:
  25. * ./runprebuild.sh
  26. * nant
  27. * cd bin
  28. * edit OpenSim.ini and appropriate files in bin/config-include
  29. * mono ./OpenSim.exe
  30. See configuring OpenSim
  31. == Configuring OpenSim ==
  32. Helpful resources:
  33. * http://opensimulator.org/wiki/Configuration
  34. * http://opensimulator.org/wiki/Configuring_Regions
  35. * http://opensimulator.org/wiki/Mysql-config
  36. When OpenSim starts for the first time, you will be prompted with a
  37. series of questions that look something like:
  38. [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:
  39. At each of these you must provide you own value or just hit enter to
  40. take the default (in this case "OpenSim Test").
  41. YOUR SIM WILL NOT BE STARTED UNTIL YOU ANSWER ALL QUESTIONS
  42. Once you are presented with a prompt that looks like:
  43. Region# :
  44. You have successfully started OpenSim.
  45. == Connecting to your OpenSim ==
  46. By default your sim will be running on http://127.0.0.1:9000. To use
  47. your OpenSim add -loginuri http://127.0.0.1:9000 to your second life
  48. client (running on the same machine as your OpenSim).
  49. == Bug reports ==
  50. In the likely event of bugs biting you (err, your OpenSim) we
  51. encourage you to see whether the problem has already been reported on
  52. the OpenSim mantis system. You can find the OpenSim mantis system at
  53. http://opensimulator.org/mantis/main_page.php
  54. If your bug has already been reported, you might want to add to the
  55. bug description and supply additional information.
  56. If your bug has not been reported yet, file a bug report ("opening a
  57. mantis"). Useful information to include:
  58. * description of what went wrong
  59. * stack trace
  60. * OpenSim.log (attach as file)
  61. * OpenSim.ini (attach as file)
  62. * if running under mono: run OpenSim.exe with the "--debug" flag:
  63. mono --debug OpenSim.exe
  64. == More Information on OpenSim ==
  65. More extensive information on building, running, and configuring
  66. OpenSim, as well as how to report bugs, and participate in the OpenSim
  67. project can always be found at http://opensimulator.org.
  68. Thanks for trying OpenSim, we hope it is a pleasant experience.