Skip to content

GumpDev/mars

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mars

Create Minecraft plugins easier, like make a plugin on earth but in mars


Topics


🪐 What is Mars?

Mars' goal is to standardize and facilitate the creation of minecraft plugin, for example you can create a simple inventory with all online players just by doing:

Player p;
GUIPagination playersInv = Mars.inventory.CreateGUIPlayers("Player list title", playerSelect -> p.sendMessage(playerSelected.getName() + " selected");
playersInv.open(p);

🔧 Installation

Installation with maven

First, add Mars' repository into pom.xml:

<repositories>
    ...
    <repository>
        <id>mars</id>
        <url>https://repo.gump.dev/snapshots/</url>
    </repository>
</repositories>

Then, add Mars' dependency too:

<dependencies>
    ...
    <dependency>
        <groupId>dev.gump</groupId>
        <artifactId>mars</artifactId>
        <version>1.0-SNAPSHOT</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

Installation with Gradle

First, add Mars' repository into build.gradle:

repositories {
    ...
    mavenCentral()
    maven {
        name = 'mars'
        url = 'https://repo.gump.dev/snapshots/'
    }
}

Then, add Mars' dependency too:

    dependencies {
        ...
        compile 'dev.gump:mars:1.0-SNAPSHOT'
    }

(i don't know if this is right, i don't use Gradle :P)


📝 Getting Started

To get started we need to start Mars and declare your intention with Mars.init(plugin), when you start Mars will register all intents events:

public final class Test extends JavaPlugin{
    @Override
    public void onEnable() {
        //'this' need be your plugin main class
        //'Intent.ALL' active all modules
        Mars.init(this, Intent.ALL);
    }
}

List of all intents:

  • ALL
  • ARMOR_STAND
  • CHAT
  • ITEMS
  • INVENTORY
  • INTERACTIONS

(you can start Mars like this: Mars.init(this, Intent.CHAT, Intent.ITEMS))

If you wanna learn more Click here to see documentation


🤔 FAQ

  • Why you created that? Cuz is so boring to create an Item with a custom name in Bukkit, it's more than 4 lines, and I'm lazy
  • I Found a BUG! Click here and open an issue
  • Can I help with the project? Sure! just send your PR :D
  • Can I contact you? Yep, send email to [email protected]

🙏 Thanks

Thanks to Dean Bassett for SkullCreator

and thanks to PNGWing for M from Mars' logo