ogb912/opensim
1
0
Fork 0
mirror of https://github.com/opensim/opensim.git synced 2026-05-15 03:15:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

adds OpenSim.ini to the gitignore and updates build instructions

Browse Source 
Signed-off-by: Skyler Clark <wgahnagl@protonmail.com>
Signed-off-by: UbitUmarov <ajlduarte@sapo.pt>
This commit is contained in:
Skyler Clark
2020-10-16 11:32:54 -04:00
committed by UbitUmarov
parent ba46b5bf8b
commit c71ea23bf5
2 changed files with 53 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -113,5 +113,6 @@ OpenSim/Tests/test-results/
test-results/
doc/html
doc/doxygen.error.log
bin/config-include/OpenSim.ini
*.patch

75
BUILDING.md
View File

@@ -1,37 +1,66 @@
# Building on Windows
Steps:
## Requirements
For building under Windows, the following is required:
* runprebuild.bat
* Load OpenSim.sln into Visual Studio .NET and build the solution.
* chdir bin
* copy OpenSim.ini.example to OpenSim.ini and other appropriate files in bin/config-include
* run OpenSim.exe
* [Visual Studio .NET](https://visualstudio.microsoft.com/vs/features/net-development/), version 2015 or later
### Building Standalone
To create the project files, run
```runprebuild.bat```
Load the generated OpenSim.sln into Visual Studio .NET and build the solution.
Copy `OpenSim.ini.exmple` to `OpenSim.ini` in the `bin/config-include` directory, and verify that the `[Const]` and `[Architecture]` sections are what you want.
copy the `StandaloneCommon.ini.example` to `StandaloneCommon.ini` in the `bin/config-include` directory.
The StandaloneCommon.ini file describes the database and backend services that OpenSim will use, and is set to use sqlite by default, which requires no setup.
Now just run `OpenSim.exe` from the `bin` folder, and set up the region.
# Building on Linux / Mac
Prereqs:
## Requirements
* Mono > 5.0
* [Mono > 5.0](https://www.mono-project.com/download/stable/#download-lin)
* On some Linux distributions you may need to install additional packages.
* msbuild or xbuild if still supported by the mono version
* See http://opensimulator.org/wiki/Dependencies for more information.
* msbuild or xbuild(deprecated) if still supported by the mono version
* See [the wiki](http://opensimulator.org/wiki/Dependencies) for more information.
From the distribution type:
### Building Standalone
To create the project files, run:
```./runprebuild.sh```
then run ```msbuild``` or ```xbuild``` if xbuild was installed.
Copy `OpenSim.ini.exmple` to `OpenSim.ini` in the `bin/config-include` directory, and verify that the `[Const]` and `[Architecture]` sections are what you want.
copy the `StandaloneCommon.ini.example` to `StandaloneCommon.ini` in the `bin/config-include` directory.
The StandaloneCommon.ini file describes the database and backend services that OpenSim will use, and is set to use sqlite by default, which requires no setup.
run `./opensim.sh` from the `bin` folder, and set up the region
For rebuilding and debugging use the msbuild option switches
* clean: `msbuild /target:clean`
* debug: (default) `msbuild /property:Configuration=Debug`
* release: `msbuild /property:Configuration=Release`
# Building other versions
Other versions of OpenSim can be built by changing the .ini files in bin/config-include
For example, if you wanted to create an instance of OpenSim running in grid mode, comment the version that you currently have, (by default it is Standalone.ini) and uncomment
```Include-Architecture = "config-include/Grid.ini"```
and copy the `GridCommon.ini.example` file to `GridCommon.ini` inside the `bin/config-include` directory.
The same can be done for `StandaloneHypergrid.ini`, and `GridHyperGrid.ini`.
* ./runprebuild.sh
* type msbuild or xbuild
* cd bin
* copy OpenSim.ini.example to OpenSim.ini and other appropriate files in bin/config-include
* review and change those ini files according to your needs
* windows: execute opensim.exe or opensim32.exe for small regions
* linux: run ./opensim.sh
* msbuild (xbuild) option switches
* clean: msbuild /target:clean
* debug: (default) msbuild /property:Configuration=Debug
* release: msbuild /property:Configuration=Release
# References
Helpful resources:
* http://opensimulator.org/wiki/Build_Instructions