https://github.com/kiip1/MineScreen

Create Minestom GUIs using an easy to use api.
https://github.com/kiip1/MineScreen

maps minecraft minestom minestom-library

Last synced: about 2 months ago
JSON representation

Create Minestom GUIs using an easy to use api.

• Host: GitHub
• URL: https://github.com/kiip1/MineScreen
• Owner: kiip1
• License: mit
• Created: 2021-09-26T16:47:57.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T18:29:08.000Z (almost 2 years ago)
• Last Synced: 2024-08-04T00:12:49.166Z (5 months ago)
• Topics: maps, minecraft, minestom, minestom-library
• Language: Java
• Homepage:
• Size: 139 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-minestom - MineScreen - A Java library for simplifying UI development. (Libraries)

README

        
# MineScreen

[![license](https://img.shields.io/github/license/kiipy/MineScreen?style=for-the-badge&color=dd7744)](./LICENSE)

[![wiki](https://img.shields.io/badge/documentation-wiki-x?style=for-the-badge&color=cc7788)](https://github.com/kiipy/MineScreen/wiki)

Create Minestom GUIs using an easy to use api.

# Installing

```groovy

repositories {

    mavenCentral()

    // Minestom repos

    maven { url 'https://repo.spongepowered.org/maven' }

    maven { url 'https://jitpack.io' }

    // Github release

    ivy {

        url 'https://github.com/'

        patternLayout {

            artifact '/[organisation]/[module]/releases/download/latest/[revision].jar'

        }

        metadataSources { artifact() }

    }

}

dependencies {

    // Minestom (new block api)

    implementation 'com.github.Minestom:Minestom:872a49d'

    // MineScreen

    implementation 'kiipy:MineScreen:MineScreen-1.0.1-dev'

}

```

# Documentation

MineScreen is poorly documented right now, but this will be improved in the future.

# Contributing

You are always welcome to contribute.

# TODO

- [x] Basic gui support.

- [ ] Add more widgets.

- [ ] Hunt for bugs and fix them.

- [ ] Center the gui to the center of the screen.

- [ ] Improve performance of MapGraphics. 

- [ ] Add more methods to MapGraphics.