Overview
What is MineShare
MineShare is an all-around cloud-based plugin for Minecraft Java Edition Server, which:
- offers new tools to create different in-game scenarios for player;
- opens new ways to define dynamic objects, like drawbridges, block-based gates, let them be triggered by switches like doors, buttons in an easy way, without the need to define complex red-stone mechanisms.
- manage players permissions in a dynamic way, where the actions of the players would grant them the rights to do the stuff in a cause-effect manner;
- Give players their sandbox (zone), where they can do whatever they like without jepardizing the common good, giving you an ultimate right even to rollback if the player's action would go too far;
- Provide tools to guide the players through the gameplay, give dynamic information about what player can do based on his in-game progress;
- adds bulk operations like selecting region, copying, rotating, filling blocks, what will accelerate your building activities;
- gives you tools to store Minecraft structures in cloud, and download them again on any other server supporting MineShare.
How to Start
You need a Paper/Bukkit Minecraft Java Server to use MineShare. The plugin is compatible with the version starting at 1.16. We recomend the usage of the latest Server. Refer to Getting started for instructions.
Features
Interactive
With MineShare you work all the time in Minecraft world, selecting portions in the 3D-space directly in Minecraft World and specifying properties of this space with different chat commands. You will never be needing to adapt configuration files in the file system and deal with yaml files. You can manage your world rules, assign rights to other players, create rules in the game, assign spaces special properties... All commands come with autocompletion features and provide hints and suggestions to start smoothly. If something unclear, please refer to documentation.
World Management
MineShare allows to specify an rules based on the area the player is acting in, with the help of zones. Players can claim the zone and do whatever they like in this zone. The state of the zone is stored, so it can be rolled back any moment. Even if the player has an exclusive rights in his zone, the world owner can revert its state any time.
Fun Features
MineShare offers a lot of features that extends and enhances the standard Minecraft expirience. As an example you can select a region in world and record frame-by-frame like a cartoon the states of blocks, associate a trigger with this animation.
Every time the player would trigger the trigger the sequence will be played back. It allows creating easily of the dynamic content on the server you would not be able to produce in standard server.
Define spawning areas where the defined by you set of entities is spawned. The population of the entities will be controlled by the plugin. If the entity will die - it will be recreated.
Alternative Identities
As an owner of the server and server operator you have maximum privileges on the server, still when you manage rights of other players you need to test what kind of restrictions these player have, for this you can easily change your identity and see what the other players can and what not. .
In-Game Rules
MineShare allows to manage the state of the world objects, zones and players dynamically, based on the actions the player does in the game. You can create rules that will grant players rights if they reach specific block, or get teleported by the gate or passes a specific space, and so on. See how it is managed with tokens and groups. Tasks allow to give to the player information about what he can do in the zone and is dynamically dependent on the current in-game progress of the player.
More to Come
The set of features of MineShare plugin is growing, so stay tuned.. more to come!
Objects
The in-game processes are controlled by the MineShare objects, which are created by the world builders or by the zone's builders in the game.
Worlds
Usually every server gets at least 3 worlds:
- world itself;
- nether;
- the end.
With MineShare you can create new worlds and allow players to teleport between them. See here. The MineShare supports two groups for each world:
- owner
- builder.
See here a detailed explanation of it. The worlds are initially created without any group assigned, so anyone can assign himself as a world's owner. This could be a problem on the public server, so please restrict these groups to a trusted set of players. One exile location can be specified in the world. The players are teleported in this location in case the player exposes some bad behaviour (arson, lava-bucket emptying, other types of griefing). If the exile location is located within a zone then the exile zone is activated. For exile zone an additional exile-over token can be specified. If it is set, the player will be confined within an exile zone until he will receive the respective token. See the [tokens] discussion.
Zones
Zones are a spacial regions within a world. Players can claim regions in the world if the regions are not claimed by anybody. See here. Zones have snapshot mechanism that allows to preserve the state of the zone's block and revert it back to any point of time. One zone in the world can be specified as an exile zone.
Tasks
In every zone the owner can create some activities for the guests of the zone. The tasks allows to inform the player what exactly he can do in the zone. The tasks are dynamic and are dependent on the current player in-game progress. Tasks are started and finished based on the tokens assigned to the player. Task can be done in repetitive manner as tokens can be assigned only for a specific period of time.
Groups
Groups are used to manage privileges of different players on the Minecraft server.
Groups can contain:
- Group Admins (defines who can change the group):
- Admin Users (players who can change the group);
- Admin Groups (other groups, which contain users who can act as an admins of the group);
- Players (direct list of player ids);
- Other Groups (allows to have a hierarchy of groups);
- Tokens: Dynamic way to assign players to the group based on actions they are doing in the game:
| Type | Description |
|---|---|
| or-tokens | the player has to have one of the tokens from this type to be part of the group |
| and-tokens | the user has to have all of these tokens to be part of the group |
| no-tokens | the user should NOT have any of the tokens of that type to be part of the group |
Groups can be set to the objects to define the group of players who can do the specific actions with the MineShare objects.
| Object | Group | Right |
|---|---|---|
| Block | owner | Change/Delete an object |
| Block | allow-change | Allows changíng the block: open the door, open the chest, and so on |
| Gate | owner | Change/Delete an object |
| Gate | allow-travel | Allows usage the gate |
| Space | owner | Change/Delete an object |
| Spawner | owner | Change/Delete an object |
| Token | owner | Change/Delete an object |
| Token | allow-assign | Allows setting the token to the objects |
| Zone | owner | Change/Delete an object |
| Zone | allow-build | Allows building and creating other MineShare objects in the zone |
| Zone | allow-entrance | Allows entering the zone |
| World | owner | Defines the owner of the world (max privileges) |
| World | allow-build | Allows building and creating other MineShare objects in the world |
If the group is not assigned to the object, then it is considered unrestricted and anyone can execute the respective set of operations. If the group is assigned, but the group is empty - it acts the same way - no restrictions are applied to the object's operation.
Tokens
Tokens can be created to manage the rights of the players dynamically based on their actions. Tokens can be created as a special tag that will be assigned to the player in case he does specific action. The token can be associated with following objects:
| Object | Action |
|---|---|
| Block | If the block is activated (door opened, button pushed, etc.) |
| Gate | Player travels through the gate |
| Space | Player passes through the space |
The token has a group allow-assign. Only the users from this group will be allowed associating the token with the block. It is important right, otherwise anyone will be allowed to grant the token and as a result the rights associated with this token.
The tokens can be associated with the groups, which allows to assign the players to the group dynamically. Please, see the difference between the or-token, and-token and no-token group association.
The tokens can also be associated with blocks to manage the visibility of block's inventory.
And the token can be used to end the exile of the player.
Blocks
Blocks allows to manage the Minecraft blocks. They are important for the dynamic blocks like:
- doors;
- chests;
- buttons;
- floor panels.
If the block is created for the respective block the groups can be assigned to the block, which can prevent the block to act for the players not in the respective group.
For chests an inventory items can be added to the block. These items will be presented to the player if he opens a chest. The presence of the special block inventory can be managed by the inventory token. If the player has a token - he will see a special inventory, and if not - then the usual chest inventory will be opened.
Gates
Gates allows teleporting the players between the location where the gate is created and where the destination point is set.
Spaces
Spaces allows specify special properties for the areas in the Minecraft world. A 3d frame-by-frame animations can be specified with this object. The animations can be triggered by the dynamic blocks (doors, chests, and so on) in the Minecraft.
Spawners
Spawners allows creating an area with controlled entity population. The set of entities can be added to the spawner. MineShare will take care that the specified entities be re-spawned in the specified area with the defined interval.