https://github.com/mhigists/rpglike

RPGLike feel for Minecraft
https://github.com/mhigists/rpglike

php php7 pmmp-plugin

Last synced: about 21 hours ago
JSON representation

RPGLike feel for Minecraft

• Host: GitHub
• URL: https://github.com/mhigists/rpglike
• Owner: MHIGists
• License: cc0-1.0
• Created: 2020-04-03T01:33:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-09-01T12:44:18.000Z (about 2 years ago)
• Last Synced: 2024-09-26T10:21:55.783Z (about 21 hours ago)
• Topics: php, php7, pmmp-plugin
• Language: PHP
• Homepage:
• Size: 296 KB
• Stars: 19
• Watchers: 4
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        







RPGLike


  


    This plugin aims to add higher RPG feel to Minecraft adding attributes and skills.

    


    


    


    Report Bug

    ·

    Request Feature

  





  
Table of Contents

  


    


      About The Project

    

    


      Getting Started

      


        
Installation

      

    

    
Usage

    
Roadmap

  




## About The Project

Started this as a side project. I'm currently working full time so update frequency may vary


depending on my workload. My aspirations for this project is ultimately creating a mini-game


with as much as storyline and quests so that's something to look forward.Until then 


we have something that slightly enhances player in-game experience but it's still fun.


I'm grateful for every contribution you make. Even as much as testing takes a lot of my time which I don't have.





## Getting Started



### Installation 



Just open the releases tab and download one of the official releases, then place it in the plugins folder.



## Usage



Aftrer installation and initial start you can check the plugin data folder of the plugin


to configure the plugin to your liking.


### messages.yml:


Here you can change every string that's displayed to the player.

###  players.yml

Here are all the players that've connected to the server with all their attributes.

### config.yml

Here are all the settings of the plugin. Here is a quick rundown of the settings you'll need.


#### keep-xp:


Pretty self-explanatory this setting has 2 values. true or false. Controls whether the player


loses all attributes,skills,traits and levels when they've died.

#### discovery:

This setting has 2 values true or false. When set to true it will hide every skill and trait until the


player have unlocked it.


When set to false all skills and traits will be visible in the /rpg menu.

#### Hud

Here you can turn on or off the included HUD. Change the message it transmits, its period in which its transmitted


and the timezone of the server.

#### Skills

Here are all the skills the plugin has. Here is the Tank skills for example.


If you look at [levels]() you will see under it all the available levels for this particular skill.


You are free to add new levels to your liking. Just be sure to keep the spacing of it. As a hint you can copy level 2


place it right under it. From there you can simply change 2 => 3 and change its values. Now here are the values


under [unlock]() you have first the Attribute (VIT,DEX,STR or DEF) you can freely change this as you like. 


on the right of the Attribute you have the points a player must have in order to unlock it. If you want to add more


Attributes to unlock a skill just add a new line under unlock with the next requirement in the format [Attribute]() : [Points]()


Under [unlock]() you have [chance]() from there you can configure the chance at which a skill's effect will trigger itself.





That about explains the [levels]() the next one is [range]() when an active or passive skill has AOE range this is where


it's configured. The value is in blocks from the source player.





[max_entities_in_range]() this option allows to set the maximum entities in the [range]() of the skill that will be affected


by the effect of the skill. The value is an integer.





[is_aoe]() controls whether the skills is aoe or not. If this option is set to true please specify [range]() and [max_entities_in_range]()




[cooldown]() controls the cooldown of an active ability it's value is an integer in seconds





[is_active]() has 2 values true and false, when set to true the skill is considered active and should have a [cooldown]().





#### Modifiers

Those are used to modify how much a player gains per point in an attribute. For example DEX with a value of 0.005 will be multiplied by the points in DEX.

Try experimenting with these to achieve the desired strength of attributes.



#### Traits

Here you can create whatever player traits you want! The constraints however are


that you the counter of each trait is connected to the 3 types of [action]() a trait currently


support. Those are "break", "kill", "pickup". "break" counts each block that's been broken


by the player. Those blocks can be set from the [blocks]() option which takes values separated by a comma.

Same with the others "pickup" counts blocks or any items picked up. And kill counts entity killed


that includes players.

[levels]() is the same as in the skills [section]().

## Roadmap



  

### Current objectives:

* Finishing the trait system with the 3 included actions.


* Active bug hunting

* More configuration for settings (there is still some hard coded stuff)

* Adding permissions and more control from in-game commands or maybe an admin form?

* Party system


After this have been completed an official release will be made until then every release should be considered a heavy WIP. 



You can contact me any time on Discord StrawberryMilk#3229


See the [open issues](https://github.com/MHIGists/RPGLike/issues) for a list of proposed features (and known issues).