https://github.com/onlivfe/core

The core functionality that's shared between all platforms & components
https://github.com/onlivfe/core

chilloutvr chilloutvr-api neosvr neosvr-api rust rust-lang social-vr vrchat vrchat-api

Last synced: 5 days ago
JSON representation

The core functionality that's shared between all platforms & components

• Host: GitHub
• URL: https://github.com/onlivfe/core
• Owner: onlivfe
• License: agpl-3.0
• Created: 2023-01-05T13:59:36.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-27T03:18:15.000Z (9 months ago)
• Last Synced: 2024-05-29T02:15:30.572Z (5 months ago)
• Topics: chilloutvr, chilloutvr-api, neosvr, neosvr-api, rust, rust-lang, social-vr, vrchat, vrchat-api
• Language: Rust
• Homepage: https://onlivfe.com
• Size: 168 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Onlivfe core

Onlivfe core is the a library that provides the models & some of the logic for onlivfe.

It's usage is not supported outside of the onlivfe ecosystem, though we won't stop others from using it.

Also note that the license is [AGPL](https://tldrlegal.com/license/gnu-affero-general-public-license-v3-(agpl-3.0)).

## Development

Basic requirements:

- [Git](https://git-scm.com)

- [Rust](https://www.rust-lang.org/)

### Building

Start off by cloning the project with git.

```sh

git clone https://github.com/onlivfe/core

```

Then open the project folder in your terminal, & run `cargo build`.

Then get to hacking, & optionally replace the dependency in other projects by [overriding dependencies](https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html).

### Storage

The `core` abstracts away storage backends, so that consumers can optionally provide their own.

This is done so that for example in the future `core` could easily be used via WebAssembly,

as long as there is a compatible storage backend.

In the short term, there's a in-memory caching backend, which should be enough to start developing other parts of the system.

It's also hopefully good enough for the initial MVP of onlivfe.

In the long term, a standard database backend is being developed, with proper support for historical data.