Upstream/Jobs
1
0
Fork 0
mirror of https://github.com/Zrips/Jobs.git synced 2024-11-25 03:55:13 +01:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source 
- Since there's no jenkins or releases it will always show red in the top icons, I've removed the two
- Moved the issues and pulls icons to the same line as the first two
- Moved the header with the image to the top
- Re-wrote the introduction text to be more friendly, yet informative. And proofread it for grammar/spelling. This way it's a bit more modern and current.
- Made sure the headers `#` vs `##` are a bit better (consistency)
- Made sure there was a clear mention near the top of the required cmilib library
- Made the introduction more friendly to the releases links, and include cmilib there, as well a mention that tech savvy people can get the code and compile it, 
- Included a bit more clear listing for officially supported (and not..) server engines. People who confirm this works on their modded server are free to clone/pr their findings I guess
- Included installation instructions for people who don't want to deal with code, or are new to server running, they now can find the download links, the required library file, and the extra server restart text .. all in one readme document. hopefully lowering the 'it does not work' questions on discord etc.
- Bugs and suggestions - this is added to explain where to post what, and that if they know how to fix the bug that they can clone/pr it.
- Moved support before API, and moved API as a whole lower on the page.
- Made sure discord community is part of support
- Included link to the official zrips.net website for the jobs/api uner API
- And I've moved the credits to the bottom, as most ppl who come to github come to find out what this is about, how to get it, how to get support .. so credits can be a bit lower. And I've included a link to the contributions made by others. I hope it's the correct way of doing that. 
- General grammar/spelling reviewed.
- Made the document a bit more 'the same as' to match the more recent cmilib readme update. (more indirect-consistency) 
- Included basic permissions examples, because I noticed on discord people keep asking a few times per week.
This commit is contained in:
Floris 2023-01-31 11:43:32 +01:00 committed by GitHub
parent e6c476f756
commit 43b705195c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 112 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
README.md
View File

@ -1,25 +1,109 @@
[![GitHub license](https://img.shields.io/badge/license-Apache-brightgreen.svg)](https://github.com/Zrips/Jobs/blob/master/LICENSE-Apache.txt) [![GitHub license](https://img.shields.io/badge/license-GNU--GPL-brightgreen.svg)](https://github.com/Zrips/Jobs/blob/master/LICENSE-GNU-GPL.txt)
# Jobs Reborn
[![GitHub Pre-Release](https://img.shields.io/github/release-pre/Zrips/Jobs.svg)](https://github.com/Zrips/Jobs/releases) [![Github All Releases](https://img.shields.io/github/downloads/Zrips/Jobs/total.svg)](https://github.com/Zrips/Jobs/releases)
[![GitHub issues](https://img.shields.io/github/issues/Zrips/Jobs.svg)](https://github.com/Zrips/Jobs/issues) [![GitHub pulls](https://img.shields.io/github/issues-pr/Zrips/Jobs.svg)](https://github.com/Zrips/Jobs/pulls)
Jobs Plugin for the BukkitAPI
***
# Jobs
![Image of Jobs](https://www.spigotmc.org/data/resource_icons/4/4216.jpg?1424463769)
_Original author and manager of this was phrstbrn until [v2.12.0](https://dev.bukkit.org/projects/jobs/files/808311) version._
-------
A fully configurable plugin that allows you to get paid for breaking, placing, killing, fishing, and crafting, and more. Class based professions, gain experience as you perform your job.
[![GitHub license](https://img.shields.io/badge/license-Apache-brightgreen.svg)](https://github.com/Zrips/Jobs/blob/master/LICENSE-Apache.txt) [![GitHub license](https://img.shields.io/badge/license-GNU--GPL-brightgreen.svg)](https://github.com/Zrips/Jobs/blob/master/LICENSE-GNU-GPL.txt) [![GitHub issues](https://img.shields.io/github/issues/Zrips/Jobs.svg)](https://github.com/Zrips/Jobs/issues) [![GitHub pulls](https://img.shields.io/github/issues-pr/Zrips/Jobs.svg)](https://github.com/Zrips/Jobs/pulls)
Links
- Bukkit: https://dev.bukkit.org/projects/jobs-reborn
- Spigot: https://www.spigotmc.org/resources/4216/
-------
## Introduction
Welcome to the Minecraft plugin that makes the gaming experience for your players even more exciting!
With this plugin, a player can pick their favorite job(s), such as building, mining, fishing, and crafting. By just playing they can earn rewards like job points, job experience that helps them level up, and ingame money (requires economy engine).
Whether they're a seasoned player or just starting out, they'll love the class-based professions and the satisfaction of leveling up as they master their chosen job(s).
Get ready for a whole new world of fun and rewards! This plugin works great together with the premium plugin CMI.
## Required Dependancy
To ensure the best experience with the Zrips made plugins, including Jobs Reborn, it's important to have the CMILib library installed.
We've made it easy for you by providing the latest .jar file. Simply make sure to include this library when you first install Jobs (or when you upgrade to a newer version), and you'll be on your way to enjoying all the fun and benefits our plugins have to offer.
## Releases / Downloads
We highly recommend keeping the Jobs Reborn .jar file, as well as all Zrips plugins, up-to-date. You can easily download the latest releases from the following links:
- CMILib Library: https://www.zrips.net/cmilib/
- Jobs-Reborn Plugin: https://www.spigotmc.org/resources/4216/
- For the tech-savvy, you can also access the latest Jobs source code on Github and compile it yourself.
- The old Bukkit Platform: https://dev.bukkit.org/projects/jobs-reborn
## Minecraft Server Engines
Jobs is designed for and officially supported on the following server engines:
- Spigot: https://www.spigotmc.org/
- Paper: https://papermc.io/
While other server engines are not officially supported, direct forks of Spigot and Paper _may_ still be compatible. Here are a few examples:
- PurPur
- Tuinity
Please note that these unsupported engines are used 'as is' and may not offer the same level of support or performance as the officially supported engines.
## Installation Instructions
To install the Jobs-Reborn plugin along with the CMILib library, follow these steps:
- Backup your server by running the /stop command.
- Download the latest CMILib .jar file and place it in the ~/plugins/ directory.
- Also include the Jobs-Reborn .jar file in the ~/plugins/ directory.
- Start your server back up.
- After the initial run, if you see the message 'Done!' with no issues, the plugin will have generated the necessary language and configuration files.
- Stop and restart the server one more time to review the plugin configurations. You can customize jobs, economy, chat settings, and more by following the guidance on the zrips.net > Jobs pages.
## Basic Permissions for Players
The Jobs-Reborn plugin requires some configuration in order for players to use the plugin, this includes the ability to use it, to browse and pick jobs, and to only get paid out in certain worlds. Below is an example of some basic permissions you can consider using to achieve that. (This requires a permission manager)
```
jobs.command.browse
jobs.command.info
jobs.command.join
jobs.command.leave
jobs.command.stats
jobs.command.top
jobs.join.*
jobs.max.3
jobs.use
jobs.world.world_overworld
jobs.world.world_theend
jobs.world.world_thenether
```
For example, using LuckPerms you could update the default group as such:
```
lp group default permission set jobs.use true
lp group default permission set jobs.max.1 true
lp group donator permission set jobs.max.2 true
```
## Bugs and Suggestions
Feel free to clone and submit a pull request with bug fixes or code suggestions.
If you're not familiar with the process, you can also report bugs and make suggestions as an issue (if one doesn't already exist) under the [Issues tab](https://github.com/Zrips/Jobs/issues) on Github.
## Support
You can request support from other Community Members on the [Zrips Community Discord](https://discord.gg/dDMamN4). (Pick the right roles, to unlock and show the plugins' #help channels.)
Please do check [the zrips.net/jobs website](https://www.zrips.net/jobs/) out first, before asking questions.
## Jobs API
- Information: https://www.zrips.net/jobs/api/
You can manually add the .jar file to your build path or you can use Jitpack if you use Maven or Gradle:
### Maven
# Jobs API
You can manually add the jar file to your build path or you can use jitpack if you use maven or gradle:
## Maven
```xml
<repositories>
<repository>
@ -37,7 +121,9 @@ You can manually add the jar file to your build path or you can use jitpack if y
</dependency>
</dependencies>
```
## Gradle
### Gradle
```gradle
repositories {
maven {
@ -49,4 +135,13 @@ dependencies {
}
```
### API Events
For API events: https://github.com/Zrips/Jobs/wiki/API
## Credits
- _Original author and manager of this was phrstbrn until [v2.12.0](https://dev.bukkit.org/projects/jobs/files/808311) version._
- Current development: [Zrips](https://www.spigotmc.org/resources/authors/zrips.24572/)
- Contributions: https://github.com/Zrips/Jobs/graphs/contributors