mirror of
https://github.com/SimplexDevelopment/FeelingLucky.git
synced 2024-11-25 11:25:02 +00:00
Added README.md
This commit is contained in:
parent
4232842749
commit
67734f3f89
14
build.gradle
14
build.gradle
@ -3,22 +3,16 @@ plugins {
|
||||
}
|
||||
|
||||
group = 'io.github.simplex'
|
||||
version = 'Beta-1.0.2'
|
||||
version = 'Beta-1.1.0'
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
maven {
|
||||
name = 'papermc-repo'
|
||||
url = 'https://papermc.io/repo/repository/maven-public/'
|
||||
}
|
||||
maven {
|
||||
name = 'sonatype'
|
||||
url = 'https://s01.oss.sonatype.org/content/groups/public/'
|
||||
}
|
||||
maven { url = uri("https://s01.oss.sonatype.org/content/groups/public/") }
|
||||
maven { url = uri("https://papermc.io/repo/repository/maven-public/")}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly 'io.papermc.paper:paper-api:1.18.1-R0.1-SNAPSHOT'
|
||||
compileOnly("io.papermc.paper:paper-api:1.18.2-R0.1-SNAPSHOT")
|
||||
}
|
||||
|
||||
def targetJavaVersion = 17
|
||||
|
28
src/README.md
Normal file
28
src/README.md
Normal file
@ -0,0 +1,28 @@
|
||||
# <center>FeelingLucky Beta v1.1.0</center>
|
||||
|
||||
## <center><u><span style="color:blue">Plugin Description:</u></center>
|
||||
|
||||
### <center><u><span style="color:cyan">For All Users:</u></center>
|
||||
|
||||
<b>FeelingLucky</b> is a mechanics plugin designed to expand upon the Luck attribute which Minecraft provides.
|
||||
Each user is assigned a tangible Luck stat, which can be viewed by using <b><span style="color:violet">/luck info</color></b>.
|
||||
Users can <i>increase</i> their luck stat by using a rabbit's foot,
|
||||
or increase their luck and their luck multiplier by consuming a special rabbits foot purchased from a Butcher villager.
|
||||
<b><span style="color:red">Beware</b> though, if you take damage from guardian lasers or a witch's potion,
|
||||
there's a chance your luck will <i>decrease</i> instead.
|
||||
|
||||
### <center><u><span style="color:pink">For Administrators:</u></center>
|
||||
Admins can modify values in the configuration file, as well as modify individual user's luck stat.
|
||||
Admins can set, reset, add to, and take from player's luck stat.
|
||||
Admins can also reload the main configuration, as well as individual and all player configurations.
|
||||
For this, the command is <b><span style="color:violet">/luck reload -m</color></b> for the main config,
|
||||
<b><span style="color:violet">/luck reload</color></b> to reload all player configurations, and <b><span style="color:violet">/luck reload -p <i>PLAYER_NAME</i></span></b> to reload individual player configuration files.
|
||||
|
||||
## <center><u><span style="color:blue">Server Requirements:</u></center>
|
||||
|
||||
In order to run <b>FeelingLucky</b> v<b>1.1.0</b>, the latest version of Paper or Spigot is required.
|
||||
|
||||
#### <center><span style="color:red">Note: Paper is REQUIRED for this plugin to run. Spigot is not supported, and support for Spigot will not be added in the future.</center></span>
|
||||
|
||||
### <center>Note: If you are migrating from an Alpha build, the plugin configuration folder will need to be regenerated.</center>
|
||||
|
@ -1,6 +1,5 @@
|
||||
package io.github.simplex.luck.util;
|
||||
|
||||
import io.github.simplex.luck.listener.AbstractListener;
|
||||
import io.github.simplex.luck.player.Luck;
|
||||
import org.bukkit.Bukkit;
|
||||
import org.bukkit.entity.Item;
|
||||
|
Loading…
Reference in New Issue
Block a user