Warning

This repository is currently pre-alpha, breaking changes happen frequently, there have not been any security audits, and data loss is expected.

Join the Discord!

Client

OpenMinerva is the no-nonsense self-hosted virtual collaboration environment for flatscreen / VR / AR.

About

OpenMinerva aims to be a platform-agnostic flatscreen / virtual reality / augmented reality sandbox application that is fully self-hostable, and completely open source.

To learn more about the OpenMinerva project, please read the PHILOSOPHY.md document. This document provides use-cases targets and other reasoning for this project.

Installation

To obtain a binary of this application, please visit the Releases page and find the version you need. Extract the downloaded archive into a folder, and run the provided executable. If you are wanting the latest stable release of this application please look for Releases tagged in the order of "master", "beta", "alpha". If you are needing another version of this application, please see Key Branches for help with locating your desired version. There are no other ways to obtain a compiled binary outside of this repository. There are currently no official distributions of OpenMinerva though package managers or game launchers.

Development Quick Start

Download source code

For cloning this project on Linux:

# Clone this repository.
git clone --recurse-submodules https://github.com/OpenMinerva/client 

Setup the environment

This repository does not ship some required addons in order to prevent unnecessary weight in the git history. Instead there is a script /src/setup_environment.sh (Linux only) that can be executed to automatically download the addons. Windows users will need to install these addons manually for now.

For simplicity, here is a list of the missing addons:

• godot-sqlite - Tagged v4.8 - Download
• gdUnit4 - Tagged v6.2.1 - Download

Download these addons into the /src/addons/ folder of this repository. Example:

/src
    /addons
        /godot-sqlite
        /discord-rpc-gd
        /rpc-await

Import project into Godot.

• Open your copy of the Godot Engine.
• Click on "Import" near the top of the application window.
• Navigate to the location where the source code was downloaded to.
• Navigate to the sub-directory /src.
• Select project.godot to import this project.

Need help with getting set up?

Make an issue! You may select Documentation Issue as your reason.

Contributing

See CONTRIBUTING.md for guidelines, and information.

Used Addons

These addons are used in building the OpenMinerva client:

Addon Name	Status	Code URL	License	Source URL
Gizmo3DScript	Forked	Usage	MIT	Source
Discord-RPC-GD	Forked	Usage	MIT	Source
rpc-await	Forked	Usage	MIT	Source
at-icons	Forked	Usage	MIT	Source
godot-oauth2client	Owner	Usage	MIT	Source
godot-urlparser	Owner	Usage	MIT	Source
godot-sqlite	Downloaded	Not included	MIT	Source
gdUnit4	Downloaded	Not included	MIT	Source