KnarCraft/Launchpad
KnarCraft/Launchpad
1
0
Fork 0
mirror of https://github.com/SunNetservers/Launchpad.git synced 2024-12-05 01:43:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Adds README

Browse Source
This commit is contained in:
Kristian Knarvik 2023-06-30 15:26:29 +02:00
parent e6bc5908f5
commit 394631c560
2 changed files with 43 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md Normal file
View File

@ -0,0 +1,41 @@
# Launchpad
Launchpad is a simple but configurable plugin able to make any placeable block into a launchpad which launches a player
with the desired velocity in their current or in a fixed direction. While anything can be a launchpad, pressure plates
have more accurate hit-detection as that's built into Minecraft.
Launchpads will prioritize values specifically set for that launchpad. If not set, they will look for material-specific
values. If not set, they will look for the generic velocities in the config.
## Commands
Note that changing a property for a block which isn't currently a launchpad will turn the block into a launchpad.
If you alter several launchpad values in succession, they'll all be applied to the next block you right-click.
| Command | Arguments | Description |
|-------------------------------|--------------------------------------|-------------------------------------------------------------------------------------|
| /launchpad add | | Makes the clicked block into a launchpad. |
| /launchpad remove | | Removes the clicked block as a launchpad. |
| /launchpad abort | | Clears any unprocessed launchpad modifications. |
| /launchpad verticalVelocity | Decimal number / "null" | Sets the vertical velocity for the clicked launchpad. Use "null" to unset. |
| /launchpad horizontalVelocity | Decimal number / "null" | Sets the horizontal velocity for the clicked launchpad. Use "null" to unset. |
| /launchpad fixedDirection | NORTH / SOUTH / EAST / WEST / "null" | Sets a fixed direction the launchpad will launch every player. Use "null" to unset. |
| /launchpad:reload | | Reloads the configuration and launchpads from disk. |
## Permissions
| Permission | Description |
|------------------|---------------------------------------------------|
| launchpad.admin | Gives all other permissions |
| launchpad.modify | Allows modifying, adding and removing launchpads. |
| launchpad.reload | Allows reloading the launchpad plugin. |
## Configuration
| Node | Type | Description |
|------------------------------------------------------------|----------------|--------------------------------------------------------------------------------------------------------------|
| launchpad.materials | List | A list of materials which are always treated as launchpads, without the need for manual registration. |
| launchpad.verticalVelocity | Decimal number | The vertical (upwards) velocity applied to launchpads if not specified otherwise. |
| launchpad.horizontalVelocity | Decimal number | The horizontal (sideways) velocity applied to launchpads if not specified otherwise. |
| launchpad.materialVelocities.<MATERIAL>.horizontalVelocity | Decimal number | The horizontal (sideways) velocity applied to launchpads of type <MATERIAL> if not overridden for the block. |
| launchpad.materialVelocities.<MATERIAL>.verticalVelocity | Decimal number | The vertical (sideways) velocity applied to launchpads of type <MATERIAL> if not overridden for the block. |

4
src/main/resources/config.yml
View File

@ -4,9 +4,9 @@ launchpad:
materials:
- LIGHT_WEIGHTED_PRESSURE_PLATE # This is the gold pressure plate
- HEAVY_WEIGHTED_PRESSURE_PLATE # This is the iron pressure plate
# The default vertical (upwards) velocity set for a player
# The default vertical (upwards) velocity for all launchpads
verticalVelocity: 0.2
# The default horizontal (outwards) velocity set for a player
# The default horizontal (outwards) velocity for all launchpads
horizontalVelocity: 0.5
# Default velocities for specific launchpad materials. You can use this to set up different velocities for each type
# of pressure plate or other material.