Skip to content

Relluem94s/RelluEssentials

Repository files navigation

Rellu Essentials

a Spigot Plugin compatible with Spigot 1.20.1

First Steps

Find out how to get the plugin and how to use it.

Usage of Plugin

  1. Download or Build the plugin jar
  2. Copy the jar into the plugin Directory
  3. Start and Stop the Server
  4. Set Host, User and Password of your MySQL Server in the config.yml
  5. Start your Server again
  6. Enjoy

Build

  1. git clone https://github.com/Relluem94/RelluEssentials.git
  2. git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
  3. mvn clean install

Deploy Package

  1. Make sure that your GitHub token is in your maven settings.xml (~/.m2/settings.xml)
  2.  mvn --batch-mode deploy

Development

./RelluBash-Script-Collection/dev/MinecraftDevelopmentEnvironment.sh

it will run a specified Dev-Sever (with docker mysql and phpmyadmin) check RelluBash-Script-Collection

Functionality

What does the plugin include?

Commands

  • Admin gives Clearing Chat, Fake AFK, Teleport to the highest Block and Custom NPCs (/admin)
  • Away from Keyboard (/afk)
  • Teleports to the latest Checkpoint (on spawn, teleport, world, warp and home) (/back)
  • Opens Bag Pack Menu (/bags)
  • Broadcasts Message to online Players (/broadcast)
  • Gift Cookies (/cookie)
  • Change time to Day (/day)
  • Open the Enderchest (/enderchest)
  • Linux Like (/exit)
  • Flymode (/fly)
  • Gamemode (/0 /1 /2 /3)
  • List all Gamerules for the current World (/gamerules)
  • Play as god (/god)
  • Gives a Player Head (/head)
  • Heal yourself if you low on health (/heal)
  • Teleport to your Bed spawn location or set list tp to homes that get saved in players.yml (/home)
  • Open the Inventory (/inv)
  • Message other Players (/msg)
  • Get More Stuff (/more)
  • Nick Player (/nick)
  • Change time to Night (/night)
  • Set Permission Group (/setGroup)
  • Poke a Player if he does not respond (/poke)
  • Portable Craftingbench (/craft)
  • Print Message in Chat in Player / Commandblock Name (/print)
  • Protect your Chests, Doors and other Blocks with (/protect)
  • Shows you your Money in your Purse (/purse)
  • Change Weather to Rain (/rain)
  • Save, Reload your config or more (/rellu)
  • Rename item in your Hand (/rename)
  • Repair your favorite Tools (/repair)
  • Does a rollback of a player (/rollback) (WIP)
  • Edit or Copy your Signs (/sign)
  • Teleport to Worldspawn (/spawn)
  • Change your Speed with (/speed)
  • Change Weather to Storm (/storm)
  • Linux Like (/sudo)
  • Kill yourself (/suicide)
  • Change Weather to Sun (/sun)
  • Teleport to other Players (/tp)
  • Teleport to or a Player (/teleport)
  • Shows all Team Members (mod and higher) (/team)
  • Send a Title to a Player (/title)
  • Vanish you from other Players (/vanish)
  • Warps you to a defined Point (/warp)
  • Show where a Player is (/where)
  • Show Worlds or Teleport to the spawn (/world)

NPCs

  • Custom NPC via Database or via API
  • NPCs in Game via Database
    • Adventurer
    • Baker
    • Butcher
    • Farmer
    • Fisher
    • Florist
    • Lumberjack
    • Miner
    • Musican
    • Shepherd
    • Smith
  • NPCs in Game via Code
    • Bag Salesman
    • Banker
    • Beekeeper
    • Enchanter (WIP)

Bags

  • Custom Bags via Database
    • Mining Bag
    • Farming Bag
    • Monster Bag
    • Shepherd Bag
    • Lumberjack Bag

Functional Block Protections

  • Add additional Blocks via Database or via API

Enchantments

  • Replenishment (Auto Replant Seeds)
  • Autosmelt (Smelts all Blocks)
  • Telekinesis (Teleports item into Inventory)
  • Delicate (Prevents breaking immature Crops and Stems)
  • Thunderstrike (Strikes Entity with a Lightning Bolt)

Skills

  • Skills will be reworked. Some as Enchant some as Skill. (WIP)
    • TreeFeller (Fell the whole Tree) [he is dead jim]
    • Repair (Repair Tools and Armor) [the lost son]
    • Salvage (Salvage Tools and Armor and get back resources and enchantments) [needs some love]

Events

  • Better Chat Format (Player >> Message)
    • Color Codes for VIP and higher
    • Chat Channels Vip, Mod, Admin | #v, #m, #a
  • Better Player Join Message (Shows Custom Join Message)
    • Sets Custom Tab Header and Footer (defined in config.yml)
    • Sets Flymode to enabled
      • if VIP or higer
      • if in air
      • if flymode enabled in players.yml
  • Better Player Quit Message (Shows Custom Leave Message)
  • Better Block Drop (Glass etc.)
  • Better Mobs (Disable Phantom)
  • Better (Call) Soil (disables trampling, sneak to disable)
  • Better Safety (Auto disable some commands like /pl)
  • Player Move is disabled while afk
  • Player Head Info
  • Cloudsailor (Gliding Feather and Boots)
  • Tool Crafting with Rarity, Higher Tier is unbreakable
  • No Death Message
    • Save Death Location as Home
    • Show Location in Chat (private)

Documentation

How it is working? What's under the hood?

Helpers

API

  • BagAPI
  • BankAPI
  • NPCAPI
  • PlayerAPI
  • ProtectionAPI
  • WarpAPI

Database Model

Database Model

Java CI with Maven Dependency review Dependency review