fflopsi/worldutils

A Minecraft Spigot plugin with some handy general-purpose commands

WorldUtils

This Minecraft Spigot plugin contains various tools, namely for managing both public and personal in-game positions, sending your own position, setting up a public and a personal timer, resetting the server and managing some plugin settings.

Extensions

This plugin can be extended with further functionality. When your own extension works good enough, you can apply via pull request to be listed below in the official extension list.

Official Extension List

• WUProjects

Table of Contents

• Installation
• Usage
• Contributing
• Credits
• License

Installation

To install the plugin, simply place the .jar file in the folder plugins of your server. The server must run at least Spigot, Paper is also fine (CraftBukkit does not work). On the next server (re)start, the plugin should be initialized and can be run correctly.

Usage

To use the plugin, enter an appropriate command. All commands have tab completion (except when accessing personal positions, joining personal timers of other players or resetting the server), so you do not need to know the exact syntax when typing.

The commands and their respective syntax are:

• /position <name> | list | clear | (tp | del <name>)
• /personalposition <name> | list | clear | (tp | del <name>)
• /sendposition [<playername>]
• /timer visible | running | reverse | reset | (set | add [[[<d>] <h>] <min>] <s>)
• /personaltimer (invite | join | leave | remove <playername>) | visible | running | reverse | reset | (set | add [[[<d>] <h>] <min>] <s>)
• /reset [confirm | cancel]
• /settings <commandname> <setting> true | false

Some of these commands also have an alias that can be used instead of the full command names and allow for faster command input. These aliases are:

• position: pos
• personalposition: ppos
• sendposition: spos
• timer: tmr
• personaltimer: ptmr
• settings: stg

For further information on how this all works in detail and more, visit the wiki.

Contributing

If you are willing to contribute to this project and know how to use GitHub issues, feel free to open one.

You are also welcome to fork this repository and improve it via a pull request.

Credits

I created this project after the plugin(s) German streamer and YouTuber BastiGHG is using in his Minecraft challenges.

License

This project is licensed under the MIT license. For more information, read this file.

worldutils's Issues

add setting reset.timeBefore

when makeAccessibleGlobally=true, typing an unknown position name throws an error

Describe the bug
When the setting makeAccessibleGlobally is set to true, typing an unknown position name to retrieve a known player's personal position, an error occurs.

To Reproduce
Steps to reproduce the behavior:

1. Use settings 'personalposition.makeAccessibleGlobally=true'
2. Enter command '/personalposition playername positionname'
3. See error: 'An internal error occurred while attempting to perform this command.'

Expected behavior
A message showing up with a text similar to: 'This position name is unknown in playername's personal positions.'

Minecraft:

• Client Badlion 1.17.1
• Server Paper 1.17.1 #228
• Plugin 0.3

make personalposition.makeAccessibleGlobally a personal setting

personal timer

when makeAccessibleGlobally=true, typing an unknown player name throws an error

Describe the bug
When the setting makeAccessibleGlobally is set to true, and you try to access another player's personal position, while playername is not the name of an online player, an error occurs.

To Reproduce
Steps to reproduce the behavior:

1. Use settings 'personalposition.makeAccessibleGlobally=true'
2. Enter command '/personalposition playername positionname'
3. See error

Expected behavior
A message that the player is not online right now or a wrong name was entered.

Minecraft

• Client version Badlion 1.17.1
• Server software and version Paper 1.17.1 #225
• Plugin version 0.3

fix Prefs.Option.Command.WUPROJECTS

add methods in Messages for Player#sendMessage() and Bukkit.broadcastMessage() with plugin annotations

update wiki

add arguments "invite <playername>" and "join <playername>" to command personaltimer

more message formatting

Is your feature request related to a problem? Please describe.
I don't like searching a message for the important information.

Describe the solution you'd like
I'd like to have formatted messages, where the important information is clearly legible.

Describe alternatives you've considered
Searching the message for the important information is the only alternative available; and while the issue is not critical, it would be a nice improvement.

improve confirm functionality of reset command (/reset + /reset confirm)

move ownership to organization WorldUtils

error when authors of some positions are saved and a position list is requested

Describe the bug
When authors of some positions are saved, a call to position list produces an error

To Reproduce
Steps to reproduce the behavior:

1. Make sure that at least one saved position has an author.
2. Enter command 'position list'
3. See error

Expected behavior
A normal list with all positions and authors, if applicable.

Minecraft:

• Client Badlion 1.17.1
• Server Paper 1.17.1 #228
• Plugin 0.3

[BUG] when saveAuthor=true, errors when using position ocmmand

Describe the bug
When saveAuthor is set to true, position saving and viewing does not work.

To Reproduce
Steps to reproduce the behavior:

1. Use settings 'position.saveAuthor=true'
2. Enter command '/position name'
3. See error 'An internal error ocurred ...'

Expected behavior
First call of command: 'Saved position ...'
Every further call of command: position details

Minecraft (please complete the following information):

• Client version Badlion 1.17.1
• Server software and version Paper 1.17.1 #225
• Plugin version 0.3

Additional context
When not using saveAuthor, everything works fine.

use permissions (own implementation or LuckPerms)

add plugin parameter to Messages.sendMessage methods

update versions in pom.xml and plugin.yml

error when trying to send position to unknown player

Describe the bug
When using sendposition with an unknown or offline player as argument, an error occurs.

To Reproduce
Steps to reproduce the behavior:

1. Enter command '/sendposition playername'
2. See error: 'An internal error ocurred while attempting to perform this command.'

Expected behavior
A message similar to this: 'This player is unknown or offline.'

Minecraft:

• Client Badlion 1.17.1
• Server Paper 1.17.1 #228
• Plugin 0.3

make personal positions of players accessible via console

Is your feature request related to a problem? Please describe.
I don't like it that personal positions of other players can't be retrieved via console, although it would be possible.

Describe the solution you'd like
The same as for players: A message containing the location of the position (provided makeAccessibleGlobally is set to true).

Describe alternatives you've considered
The 'console person' could just access the files, but this is not always very easy. It could also log in as a player, which is not always possible.