Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unnamed/mappa
A Configuration Map-editor heavily inspired by WorldEdit
https://github.com/unnamed/mappa
bukkit map minecraft
Last synced: 2 months ago
JSON representation
A Configuration Map-editor heavily inspired by WorldEdit
- Host: GitHub
- URL: https://github.com/unnamed/mappa
- Owner: unnamed
- License: mit
- Created: 2022-02-20T08:37:19.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-24T04:51:37.000Z (almost 2 years ago)
- Last Synced: 2023-07-14T07:37:45.120Z (over 1 year ago)
- Topics: bukkit, map, minecraft
- Language: Java
- Homepage:
- Size: 704 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Mappa
Originally called "Map Live Editor".
Has the purpose to create and edit map configurations for any kind of minigame.
Provides various useful tools to define properties like a number, a text, a vector (for locations)
and much more with In-game solutions.
The project still on alpha. Anything can be changed in any time.
## Features:
- Scheme of Minigame's map configuration in Yaml without depends on it or exposing any plugin.
- Configuration properties mapping into commands! ([Example below](https://github.com/unnamed/mappa/edit/master/README.md#scheme-configuration-example-with-snakeyaml))
- Basic types support (Integer, Double, String, Vector, Cuboid and more)
- Simple command to setup everything step-by-step (`/mappa setup `)
- Support target path to save configuration
## Scheme configuration example (With SnakeYaml)
```yaml
MyScheme:
# ▼ Any node that starts with '$' is a parse configuration for the parent node (MyScheme).
$parent: # ◄ Parent parse configuration. contains crucial configuration of the entire scheme.
aliases: [my-scheme, mys] # ◄ Aliases for command parse.
# ▼ All of these nodes that define his own types by tag '!' would be considered properties.
# ▼ Metadata tag defines properties that can be used for Mappa on his commands.
name: !metadata name
world: !metadata world
version: !metadata version
author: !metadata author
my-integer: !int + # ◄ Also the nodes can receive flags by their type.
# In this case, it is an integer with the positive flag to deny any negative int number.
my-string: !string
my-list: !list of string # ◄ Define list verbally with 'of' and the type of the list.
# Supports deep sub nodes
my-node:
my-deep-node:
my-deeper-node: !float
my-deeper-optional-node?: !float
# ▲ Question mark at the final character defines an optional node.
my-repetitive-node:
# ▼ A parse configuration to duplicate the parent node (my-repetitive-node) for each node of the array.
# ▼ Useful for cases like mini-game teams and more.
$multi-node: ['node-1', "node-2", "node-3"]
first-node: !string
second-node: !string
third-node: !string
# The multi-node result should be:
# node-1:
# first-node: !string
# second-node: !string
# third-node: !string
# node-2:
# first-node: !string
# second-node: !string
# third-node: !string
# node-3:
# first-node: !string
# second-node: !string
# third-node: !string
```
### Mapping configuration properties into commands
* Root command: `/myscheme, /my-scheme, /mys`
* Sub nodes: `/myscheme name, /myscheme world, etc`
* Deep sub nodes: `/myscheme my-node my-deep-node my-deeper-node`
## Contributing
Any kind of contribution is **accepted**!
Mappa uses **any JDK 8** with Minecraft version **target 1.8.8** to be compatible with any version.
We use the [MIT License](https://github.com/unnamed/mappa/blob/master/LICENSE), be free to clone and fork the repository always giving credits.
## TODO
- [X] Create MappaPlayer for a better project structure
- [X] Tree property command (/mappa session properties)
- [ ] Separate vector flags into different vector classes (block vector, entity vector with yaw-pitch and a double-type vector?)
- [ ] Configurate support
- [ ] Database support