Skip to content

Commit

Permalink
Initial commit - version 1.0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
CozmycDev committed Jul 18, 2024
0 parents commit dc57228
Show file tree
Hide file tree
Showing 4 changed files with 503 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# SandSpout Ability for ProjectKorra

This is an addon ability for the [ProjectKorra](https://projectkorra.com/) plugin for Spigot Minecraft servers. Inspired by the original ability that was removed from core years ago.

## Description

**SandSpout** is a Sand ability that allows earthbenders to use sand itself for mobility. This move requires that you are standing on, or are over sand. Sand blocks are configured from the global PK config.

### Features

- **Sand Column**: Raise yourself into the air on a column of sand.
- **Blindning Effect**: Applies temporary blindness to other entities within the column.
- **Damage**: Applies damage to entities within the column.
- **Sand Configuration**: Uses the global sand configuration `Properties.Earth.SandBlocks`, so you can add SOUL_SAND, '#concrete_powder', etc.

## Instructions

- **Activation**: While standing on a sand block, Left Click to activate or deactivate. Hold Space to go up, Shift to go down.

## Installation

1. Download the latest `sandspout.jar` file from [releases](https://github.com/CozmycDev/PK-SandSpout/releases).
2. Place the latest `sandspout.jar` file in the `./plugins/ProjectKorra/Abilities` directory.
3. Restart your server or reload the ProjectKorra plugin with `/b reload` to enable the ability.

## Compatibility

- **Minecraft Version**: Tested and working on MC 1.20.4.
- **ProjectKorra Version**: Tested and working on PK 1.11.2 and 1.11.3. Might support earlier versions too.

## Configuration

The ability can be configured in the ProjectKorra `config.yml` file under `ExtraAbilities.Cozmyc.SandSpout`:

```yaml
ExtraAbilities:
Cozmyc:
SandSpout:
Cooldown: 0 # milliseconds
Height: 10
BlindnessTime: 10 # seconds
SpoutDamage: 1
Sound:
Name: ENTITY_HORSE_BREATHE
Volume: 0.6 # acceptable values are 0.0 - 2.0
Pitch: 0.35 # acceptable values are 0.0 - 2.0
FlySpeed: 0.075
53 changes: 53 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>net.doodcraft.cozmyc</groupId>
<artifactId>sandspout</artifactId>
<version>1.0.7</version>
<packaging>jar</packaging>

<name>SandSpout</name>

<properties>
<java.version>1.8</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
</configuration>
</plugin>
</plugins>
</build>

<repositories>
<repository>
<id>spigotmc-repo</id>
<url>https://hub.spigotmc.org/nexus/content/repositories/snapshots/</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>org.spigotmc</groupId>
<artifactId>spigot-api</artifactId>
<version>LATEST</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.projectkorra</groupId>
<artifactId>projectkorra</artifactId>
<version>1.11.3</version>
</dependency>
</dependencies>
</project>
Loading

0 comments on commit dc57228

Please sign in to comment.