1fa28615c3
I _also_ thought this had been fixed; but Codacy is _still_ bothering me with the details. Note: my local `remark` currently doesn't complain about any other issues, so I'm re-submitting, to see if Codacy's `remark` still finds any excuse for complaining...
56 lines
4.9 KiB
Markdown
56 lines
4.9 KiB
Markdown
```
|
|
_ _ _ __ __ ___ _____ ___ _____ ___ ___ ___
|
|
| (_) |__ _ _ ___| \/ | __|_ _/_\ \ / / __| _ \/ __| __|
|
|
| | | '_ \ '_/ -_) |\/| | _| | |/ _ \ V /| _|| /\__ \ _|
|
|
|_|_|_.__/_| \___|_| |_|___| |_/_/ \_\_/ |___|_|_\|___/___|
|
|
```
|
|
# LibreMetaverse
|
|
|
|
LibreMetaverse is a fork of libOpenMetaverse which in turn was a fork of
|
|
libSecondLife, a library for developing Second Life-compatible virtual world
|
|
clients. LibreMetaverse returns the focus to up-to-date Second Life and OpenSim
|
|
compatibility with an eye to performance, multi-threading, and memory management.
|
|
|
|
The canonical source for LibreMetaverse can be found at:
|
|
https://github.com/cinderblocks/libremetaverse
|
|
|
|
## Simple installation procedure
|
|
|
|
### Linux/macOS
|
|
|
|
- Make sure you have at least `dotnet` installed, with a valid net5.0/net6.0 SDK _and_ runtime available!
|
|
|
|
- This update includes a solution file to skip the GUI applications (which will run only under Windows anyway). Use `LibreMetaverse.ReleaseNoGUI.sln` instead
|
|
|
|
- From the root, run `dotnet restore LibreMetaverse.ReleaseNoGUI.sln`. You should get some errors regarding missing Windows libraries; that's ok, you can ignore those, they're to be expected since Linux/macOS do _not_ include such libraries. Some test applications are Windows-only.
|
|
If all goes well, you should now have all dependent packages properly installed.
|
|
|
|
- From the root, run `dotnet msbuild LibreMetaverse.ReleaseNoGUI.sln`, and enjoy the superfast Roslyn compiler at work 😄 It should finish after a few minutes, depending on the speed of your machine.
|
|
|
|
- Your binaries will be under `../bin/net5.0` or `../bin/net6.0` (there might be a few more directories under `../bin`), depending on what runtimes you have installed on your system. Make sure you `cd` to the correct directory depending on the runtime you have, and then search for all your binaries there: they should be normal-looking executable files (with the `x` attribute set) and having the name of the appropriate test application (e.g. `TestClient` for the interactive testing tool).
|
|
|
|
- Unlike OpenSimulator, you don't need to launch the binaries with Mono, they're _directly_ executable; the `dotnet` chain already embeds the small runtime that allows .NET apps to run natively on whatever operating system you've got.
|
|
|
|
### Windows
|
|
|
|
For Windows, you should use the default `LibreMetaverse.sln`, just as before (untested). For command-line compilation under Windows, if you wish to skip the GUI applications, the instructions are the same as above. Use the default `LibreMetaverse.sln` if you wish to install those as well.
|
|
|
|
### GUI support under Linux/macOS
|
|
|
|
Currently unavailable, although there are some reports that this might be possible using a Windows emulator, such as Mono itself, or possibly Wine. This will require some project configuration changes, and was _not_ tested!
|
|
|
|
## Note: end-of-life support for .NET 5.0
|
|
|
|
Microsoft is [dropping support for .NET 5.0](https://devblogs.microsoft.com/dotnet/dotnet-5-end-of-support-update/) as of May 2022, so you should consider using .NET 6.0 instead (or, if you're wild, you can test the prerelease of .NET 7.0). The code runs flawlessly on .NET 6.0 as well (Windows GUI version untested)
|
|
|
|
[](https://www.nuget.org/packages/LibreMetaverse/)
|
|
[](https://www.nuget.org/packages/LibreMetaverse/)
|
|
[](https://ci.appveyor.com/project/cinderblocks57647/libremetaverse-ksbcr)
|
|
[](https://ci.appveyor.com/project/cinderblocks57647/libremetaverse-ksbcr)
|
|
[](https://www.codacy.com/gh/cinderblocks/libremetaverse/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cinderblocks/libremetaverse&utm_campaign=Badge_Grade)
|
|
[](https://github.com/cinderblocks/libremetaverse/actions/workflows/dotnet.yml)
|
|
[](https://github.com/cinderblocks/libremetaverse/actions/workflows/codeql-analysis.yml)
|
|
[](https://github.com/cinderblocks/libremetaverse/blob/master/LICENSE.txt)
|
|
[](https://www.github.com/cinderblocks/libremetaverse/)
|
|
[](https://keybase.io/cinder) [](https://keybase.io/cinder)
|