Skip to content

theSimpleCloud/SimpleCloud

Repository files navigation

Logo

A simple alternative to other minecraft cloud systems
SpigotMC · Repository · Dashboard · Discord



Overview
  1. Getting Started
  2. Features
  3. Dashboard
  4. Modules

Getting Started

Requirements

  • Java 8 or higher
  • min. 2GB Memory and 2 virtual cores

Installation

  1. Download the cloud on SpigotMC
  2. Unzip the folder and execute the start file
  3. Follow the setup instructions
  4. Connect a wrapper to your manager. It is recommended to use the InternalWrapperModule for this. You can find it below.
  5. For more information type help
  6. Have fun :D

Features

  • Dashboard
  • Language-System
  • Multi-Root
  • Multi-Proxy
  • Module-System
  • MongoDB and SQL support
  • Powerful API
  • Powerful REST-API
  • Support for Spigot, BungeeCord and Velocity
  • Template-System

Dashboard

SimpleCloud provides a Dashboard accessible for every user. The domain for the Dashboard is: http://dashboard.simplecloud.app. Now you have to enter the IP-Address of your server follwed by the port of the REST-Module.

The default port of the REST-Module is 8585. So an ip would be 55.55.55.55:8585.
The username and password can be found in "modules/rest/users.json"


Modules

SimpleCloud provides some modules by default.

Internal-Wrapper

The Internal-Wrapper Module starts a wrapper every time the manager of the cloud gets started. This wrapper does only run when the manager is running. It connects automatically with no need to set it up. The wrapper will be automatically named "InternalWrapper" and it will have 2GB of memory.
You can download it here

To edit the memory of the wrapper you can use the command:
edit wrapper InternalWrapper maxMemory <amount in MB>


Signs

The Sign Module is used to show available services for players in the lobby via a sign. The players can click on that sign and will be sent to the server. The layout of the signs is fully customizable.
You can download it here

SignModule


Permissions

With the Permission Module, you can easily manage your permissions. You can define groups and add permissions to them. You can also add permissions to single users.
You can download it here

PermissionModule


Proxy

The Proxy Module is used to manage your proxies. It controls the MOTD, Tablist, maintenance and the online count. The online count of proxies of one group will be summed up and displayed in the player info.
You can download it here

ProxyModuleTab

ProxyModuleMotd

ProxyModuleMotdMaintenance


Permissions:

Maintenance join: cloud.maintenance.join
Full join: cloud.full.join

Hub

The Hub Module provides a hub command for players to switch to a lobby server.
You can download it here


Notify

The Notify Module sends notifications to players that have the required permission when a server gets started or stopped.
You can download it here

NotifyModule


Permissions:

cloud.module.notify.messages

REST

The REST Module provides a restful API. It is necessary for the dashboard.
You can download it here


Statistics

The Statistics Module saves some statistics of the cloud. The data is displayed on the dashboard.
You can download it here


Chat + Tab

The Chat + Tab Module provides prefixes and suffixes in the tablist and adds a chat configuration.
You can download it here


Placeholders

With the Placeholders Module you can bring cloud related things like player names, proxy name, cpu usage and much more to holograms or other plugins like a scoreboard which has PlaceholderAPI support.
You can download it here


NPC

With an NPC, your players can now connect to another server not only through a classic sign. They can decorate their NPC with items and add a new title line to mark updates. You can choose between a mob like a villager or a fake player with a skin of your choice. Customize your NPC to your mode with the numerous features.
You can download it here

NPCs NPCInventory

Special Thanks To:

YourKit-Logo

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.