Skip to content

README.md

Latest commit

 

History

History
135 lines (99 loc) · 3.93 KB

README.md

File metadata and controls

135 lines (99 loc) · 3.93 KB

GameAPI

Version Java Spigot License

English | Français

A complete API for creating custom mini-games and game modes on Minecraft Spigot 1.8.

Description

GameAPI is a Java library that simplifies Minecraft mini-game / UHC development by providing a structured and modular framework. It offers tools to manage game phases, teams, kits, roles, and much more.

Features

Game Management

  • Phase System: Manage different stages of your game (lobby, game, end)
  • Game States: Control game state with smooth transitions
  • GameLoader: Automatic loading of game configurations

Player Systems

  • Teams: Complete team management system
  • Kits: Customizable kit system for players
  • Roles: Role attribution and management for players
  • Categories: Player categorization based on different criteria

Items and Effects

  • Custom Items: Create items with unique behaviors
  • Custom Effects: Activatable effects system (click, interaction, etc.)
  • Activation Modes: Control how and when effects activate

Event Management

  • EventsManager: Centralized game event management
  • AbstractEvents: Base class to create your own events

Options and Configuration

  • Game Options: Flexible configurable options system
  • Allowed Enchantments: Control available enchantments
  • Option Types: Support for different option types

Modules

  • ModuleManager: Module system to extend functionalities
  • Modularity: Extensible architecture to add new features

Utilities

  • ScoreHelper: Helper for scoreboard management
  • TimeConverter: Time conversion and formatting
  • UHCScoreBoard: Specialized scoreboard for UHC

Installation

With Maven

Add the GitHub Packages repository:

<repositories>
    <repository>
        <id>github</id>
        <url>https://maven.pkg.github.com/orisistudio/GameAPI</url>
    </repository>
</repositories>

Add the dependency:

<dependency>
    <groupId>com.github.orisis</groupId>
    <artifactId>gameapi</artifactId>
    <version>1.4.9</version>
</dependency>

Build from sources

git clone https://github.com/orisistudio/GameAPI.git
cd GameAPI
mvn clean package

The JAR file will be generated in the target/ folder.

Project Structure

gameapi/
├── category/          # Category management
├── events/            # Event system
├── game/              # Main game logic
├── items/             # Custom items and effects
├── kit/               # Kit system
├── module/            # Module system
├── option/            # Configuration options
├── role/              # Role system
├── task/              # Task management
├── team/              # Team system
├── uhc/               # UHC utilities
└── utils/             # Misc utilities

Compatibility

  • Java: 1.8+
  • Spigot: 1.8-R0.1-SNAPSHOT
  • Encoding: UTF-8

Contributing

Contributions are welcome! Feel free to:

  1. Fork the project
  2. Create a branch for your feature (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License.

Authors

Orisis Studio - @orisistudio Rammex - @Rammex

Support

For any questions or issues, please open an issue on the GitHub repository.

Developed with passion for the Minecraft community