Jobs Reborn

repository·master·Indexed 42 days ago

https://github.com/zrips/jobs

A Minecraft plugin that allows players to choose professions such as mining, fishing, or building to earn experience, job points, and in-game money. Includes a comprehensive API for Maven and Gradle, administrative tools for managing job boosts and restricted areas, and a system for tracking player statistics and job archives.

Tokens
17.1K
Snippets
63
Records
79
Agent score
3%

What's inside Jobs Reborn

  1. Configure basic player permissions

    master

    Jobs Reborn requires a permission manager (like LuckPerms) to allow players to interact with the plugin. You must grant permissions for commands, job joining, and world-specific payouts.

    Common Permission Nodes:

    • jobs.use: Allows the player to use the plugin.
    • jobs.command.browse: Allows browsing jobs.
    • jobs.command.join: Allows joining a job.
    • jobs.command.leave: Allows leaving a job.
    • jobs.command.info: Allows viewing job info.
    • jobs.command.stats: Allows viewing player stats.
    • jobs.command.top: Allows viewing the top players.
    • jobs.join.*: Wildcard for job joining permissions.
    • jobs.max.[number]: Limits the number of jobs a player can hold (e.g., jobs.max.3).
    • jobs.world.[world_name]: Restricts job payouts to specific worlds (e.g., jobs.world.world_overworld).

    Example LuckPerms configuration:

    # Set default group to use 1 job
    /lp group default permission set jobs.use true
    /lp group default permission set jobs.max.1 true
    
    # Set donator group to use 2 jobs
    /lp group donator permission set jobs.max.2 true
    lp group default permission set jobs.use true
    lp group default permission set jobs.max.1 true
  2. Install Jobs Reborn and CMILib

    master

    To install Jobs Reborn, you must also include the CMILib library in your server's plugins directory. Follow these steps:

    1. Stop your server using the /stop command.
    2. Download the latest CMILib.jar and place it in the ~/plugins/ directory.
    3. Download the latest Jobs-Reborn.jar and place it in the ~/plugins/ directory.
    4. Start your server.
    5. Once the server has finished loading (the 'Done!' message appears), the plugin will have generated its configuration and language files.
    6. Stop and restart the server again to begin customizing settings like jobs, economy, and chat.
    # Ensure both jars are in the plugins folder
    ~/plugins/CMILib.jar
    ~/plugins/Jobs-Reborn.jar
  3. View job information and statistics

    master

    The plugin provides mechanisms to view detailed information about jobs and player progression:

    • Job Info: Displays details about a job, including income (Money), experience (EXP), and points for specific materials/actions. This can be filtered by ActionType (e.g., mining, woodcutting).
    • Job Stats: Displays a player's current level, experience, and a progress bar towards the next level.
    • Player Info: Allows viewing the job status and progression of other players.
  4. Use the /jobs command

    master

    The /jobs command is the primary entrypoint for interacting with the Jobs plugin. It supports various subcommands for managing jobs, viewing player information, and checking job statistics.

    General Usage:

    • /jobs or /jobs help: Displays the help menu. You can specify a page number (e.g., /jobs help 2) to browse through available commands.
    • /jobs <command> [arguments]: Executes a specific subcommand.
    • /jobs <command> [arguments] ?: Displays the usage instructions for a specific subcommand.

    Permissions:

    • Most commands require the permission jobs.command.<subcommand>.
    • Access to specific jobs is controlled via jobs.join.<jobname>.
    • General job usage requires jobs.use.
    /jobs help
    /jobs help 2
    /jobs <subcommand> [args]
    /jobs <subcommand> [args] ?
  5. Use the editquests command

    master

    The command supports pagination and an optional action parameter.

    Usage Pattern:

    1. /editquests [page] - Lists quests starting from the specified page.
    2. /editquests [page] list - Explicitly lists quests (defaults to list if no action is provided).

    Once a quest is selected from the list, an interactive 'Main Window' opens in chat. You can click on different parts of the message to edit specific quest attributes.

    # Example: List quests starting from page 1
    /editquests 1
  6. Edit quest properties in the interactive menu

    master

    When editing a quest via the interactive menu, clicking on specific text elements allows you to change the following attributes:

    • Name: Change the display name of the quest.
    • Job: Reassign the quest to a different job.
    • Chance: Set the spawn probability (0-100).
    • Reward Amount: Set the numerical reward value.
    • Enabled: Toggle the quest on or off.
    • Level Range: Set the minimum (from) and maximum (to) player levels required.
    • Objectives: Edit the list of requirements for the quest.
    • Rewards: Edit the commands executed upon quest completion.
    • Description: Edit the quest's description text.
    • Restricted Areas: Edit areas where the quest cannot be performed.
  7. Integrate Jobs API with Gradle

    master

    To use the Jobs API in your Gradle project, add the JitPack repository and implement the Jobs dependency.

    repositories {
        maven {
            url 'https://jitpack.io'
        }
    }
    
    dependencies {
        implementation 'com.github.Zrips:Jobs:v5.2.6.2'
    }
  8. Integrate Jobs API with Maven

    master

    To use the Jobs API in your Maven project, add the JitPack repository and the Jobs dependency. Note that the scope should be provided as the plugin will be present on the server at runtime.

    <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>
    
    <dependencies>
        <dependency>
            <groupId>com.github.Zrips</groupId>
            <artifactId>Jobs</artifactId>
            <version>v5.2.6.2</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
  9. Reset job boosts

    master

    You can use the reset flag with the boost command to clear multipliers. The scope of the reset depends on the arguments provided:

    • Reset everything: boost reset resets all currency boosts for all jobs to 0.
    • Reset all currency types for all jobs: boost reset [type] resets the specified currency boost for all jobs.
    • Reset all currency types for one job: boost reset [job] resets all currency boosts for that specific job.
    • Reset a specific currency for one job: boost reset [job] [type] resets only the specified currency boost for the specified job.
    # Examples of reset commands (conceptual)
    /boost reset
    /boost reset MONEY
    /boost reset Miner
    /boost reset Miner MONEY