/lodestone_core

The backend for Lodestone, A free, open source server hosting tool for Minecraft and other multiplayers

Primary LanguageRustGNU Affero General Public License v3.0AGPL-3.0

Contributors Issues Build


Logo

Lodestone

Client for the Lodestone project
Website(Beta WIP) »

· Report Bug · Request Feature

Built With

  • Rust

(back to top)

Getting Started (end user)

Follow the instruction on our Github page

Getting Started (development)

Please make sure you have cargo and rustc, for instruction on how to install the Rust toolchain, see here: rustup.rs.

Prerequisites

  • build-essential is required for the Rust toolchain. 
    sudo apt-get install build-essential
  • pkg-config and libssl-dev are required to compile Axum 
    sudo apt-get install pkg-config libssl-dev
  • cpuidtool is required to query CPU information 
    sudo apt-get install cpuidtool libcpuid14 libcpuid-dev

Installation

Running the client

  1. Clone the repo 
    git clone https://github.com/Lodestone-Team/client
  2. By default Lodestone stores its data in ~/.lodestone. If you would like to override it for development & testing please define the LODESTONE_PATH environment variable to override it. 
    export LODESTONE_PATH=~/test_dev
  3. Running 
    cargo run --bin main

(back to top)

Contributing

Contribution is welcome, please join our Discord for more details.

(back to top)

License

This project uses the GNU Affero General Public License v3.0. See our LICENSE files for details. For an alternate (commercial) license, please raise an issue.

(back to top)

Credits

Active members of the Lodestone client team:

(back to top)