Skip to content
This repository has been archived by the owner on Jul 4, 2023. It is now read-only.

Latest commit

 

History

History
95 lines (69 loc) · 3.21 KB

README.md

File metadata and controls

95 lines (69 loc) · 3.21 KB
Raw

Macrocosm

wakatime

🎉 Open source 🎉

Completion Status

Macroocsm is far from completed and is not ready for production use. If you want to try out current features of Macrocosm you can compile it yourself.

Running Macrocosm locally

It's really not that hard.

NOTE: all the steps of this tutorial were tested on a Linux system, but I don't really see a reason why it should not work on Windows/macOS.

Prerequisites

  1. Java 17 (I use Temurin)
  2. A MongoDB instance running locally
  3. (optionally) A Prometheus instance running locally to gather server metrics
  4. Like 10 minutes you are willing to spend looking at gradle compiling kotlin

Actual usage steps:

  • Clone the repository
git clone https://github.com/Maxuss/Macrocosm && cd Macrocosm
  • Compile the JAR file

Make sure to use JDK for Java 17

./gradlew reobfJar

Two jar files will appear in build/libs directory, you want the one, titled something like Macrocosm-<version>.jar, and not Macrocosm-<version>-dev.jar.

  • Setting up the MongoDB

You will need an empty database named macrocosm and a user:

in mongosh:

use macrocosm
db.createUser({user:"<your username>", pwd:"<your password>", roles: ["dbOwner"]})

Remember the credentials, we will need them later.

  • (Optional) Set up Prometheus to scrap Macrocosm metrics

Add this to your prometheus.yml:

scrape_configs:
    # ...
    - job_name: "Macrocosm"
      static_configs:
          - targets: ["localhost:3438"]

Don't forget to restart prometheus

sudo systemctl restart prometheus.service
  • Getting the dependencies for Macrocosm

Macrocosm really requires only two dependency jars that it does not pull automatically: ProtocolLib and LibsDisguises.

  • Running a server with Macrocosm

Macrocosm requires Paper 1.19.3. So don't use Spigot or Bukkit. Put previously obtained Macrocosm-<version>.jar into the plugins folder, as well as ProtocolLib and LibsDisguises.

  • Fill out the configs

The first run the server is probably going to error out, so you need to fill the configs.

plugins/Macrocosm/config.yml:

connections:
    mongo:
        enabled: bool <set this to true to enable the server>
        username: string <your mongo username>
        password: string <your mongo password>
    discord:
        enabled: bool <set this to false if you wish to opt-out out of discord, otherwise true>
        bot-token: string <AUTH TOKEN OF THE DISCORD BOT>
        communication-channel: int <DISCORD CHANNEL ID TO BROADCAST SERVER CHAT (optional)>
        communication-webhook: string <DISCORD WEBHOOK THAT BROADCASTS THE SERVER CHAT (optional)>
        guild-id: int <YOUR DISCORD SERVER ID>
game:
    sandbox: bool <WHETHER THE GAME IS IN SANDBOX MODE>

After that you can launch the server. Do note, that not using the discord features may give you tons of errors in the console, it was not tested yet.