GalaxyViewer/ReadMe.md

GalaxyViewer

GalaxyViewer is a viewer for Second Life and OpenSimulator. It is heavily inspired by Radegast and Lumiya, using the Avalonia UI framework and .NET Core. It should work on Windows, Linux, and Android. iOS and macOS may be supported in the future.

Features unique to this viewer (compared to the stock viewer) will include:

• Popout windows for chat, inventory, etc.
• World View is optional, you can use a purely text-based interface if you prefer.
• Automation support (e.g. for bots)

Feature Roadmap

• User Authentication

  • Login
  • MFA Support
  • Saving Credentials

• Communication

  • Chat
  • Voice Chat (WebRTC)

• User Interaction

  • Friends
  • Groups
  • Profiles
  • People Search

• World Interaction

  • Teleporting
  • 3D World View
  • Rezzing Objects
  • Camera Controls
  • World Map
  • Mini Map
  • Radar
  • Nearby People
  • Places Search

• Content Creation and Management

  • Inventory
  • Appearance Editor
  • Scripting
  • Building
  • Uploading Textures
  • Uploading PBR Materials
  • Uploading Sounds
  • Uploading Meshes
  • Uploading Animations

• User Interface

  • Light and Dark Modes
  • Customizable UI (Accent Color)
  • Customizable Keybinds
  • Customizable Notifications

• Grid Manager

• Preferences

• Plugin System

• RLV Support

• Automation Support

• Accessibility

  • Screen Reader Support
  • High Contrast Mode
  • Keyboard Navigation
  • Voice Commands
  • Text-to-Speech
  • Speech-to-Text (chat input)

• Localization

• Sending Abuse Reports

• Discord Rich Presence (Desktop only)

Installation

To be added...

Building

Make sure you have the .NET Core SDK installed. We currently use .NET 9.0.

On Arch Linux you may need to use dotnet-install.sh as described here.

Clone the repository and navigate to the project directory.

Android Build Requirements

To build the Android version, you need:

• Android Studio (for SDK management and device emulation)
• Android SDK version 36 (required by the project)
• Java SDK 21

Note: If you are on Arch Linux, the aur package is missing the workload for Android. You will need to install the dotnet SDK manually as mentioned above.

Steps:

1. Download and install Android Studio.
2. Use the SDK Manager in Android Studio to install Android SDK Platform 36.
3. Make sure your ANDROID_HOME environment variable is set, or let Android Studio manage it.
4. Run:

dotnet workload install android

to install the .NET Android workload. (May require sudo privileges.)

Be sure to install the .NET things for android, wasm, etc. if you want to build for those platforms. dotnet workload install android, dotnet workload install wasm-tools, etc.

Run dotnet build to build the project.

Contributing

Contributions are welcome! Please see the Contributing file for more information.

Also, please note the Code of Conduct for this project.

Support and Contact

Please note that while the viewer is in the early development stage, it is not recommended for everyday use and no support will be given. This ReadMe will be updated with support information once the viewer is in a more stable state.

If you have any questions or concerns, please feel free to use our Discussion forum.

License

This project is licensed under the GNU Lesser General Public License - see the License file for details.

Disclaimer

This software is not provided or supported by Linden Lab, the makers of Second Life. Second Life and Linden Lab are trademarks or registered trademarks of Linden Research, Inc. All rights reserved. No infringement is intended.