Level/README.md
tastybento 95c9e55cfe
Version 2.10.0 (#283)
* Version 2.7.1

* Version 2.7.2

* Use Java 9's takeWhile

* Added placeholder %Level_[gamemode]_rank_value

Fixes https://github.com/BentoBoxWorld/Level/issues/228

* No save on disable (#231)

* Release 2.6.4

* Remove saving to database on disable.

https://github.com/BentoBoxWorld/Level/issues/229

First, the top ten tables are never actually used or loaded. They are
created in memory by loading the island levels. So there is no reason to
keep saving them.
Second, the island level data is saved every time it is changed, so
there is no need to save all of the cache on exit.

* Fixes tests

* Rosestacker (#232)

* Add support for RoseStacker 1.3.0

* Made plugin a Pladdon.

* Version 2.8.0

* Added new placeholders

%Level_%gamemode%_top_island_name_%rank% - lists the island name
%Level_%gamemode%_top_island_members_%rank% - a comma separated list of
team members

https://github.com/BentoBoxWorld/Level/issues/224
https://github.com/BentoBoxWorld/Level/issues/211
https://github.com/BentoBoxWorld/Level/issues/132
https://github.com/BentoBoxWorld/Level/issues/107
https://github.com/BentoBoxWorld/Level/issues/105

* Update to BentoBox API 1.18

* Open up modules for testing access.

* Back support for BentoBox 1.16.5.

* Version 2.8.1

* Speeds up level calculation by doing more chunk scans async.

If chests are scanned, then it will take longer because these have to be
done sync.

https://github.com/BentoBoxWorld/Level/issues/243

* add Vietnamese (#240)

* Raw island level placeholder (#241)

* Changed IslandLevelCalculator minHeight to world minHeight for negative blocks height support since 1.18. (#246)

* Version 2.9.0

* Chinese Translation (#249)

* Translate zh-CN.yml via GitLocalize

* Translate zh-CN.yml via GitLocalize

Co-authored-by: mt-gitlocalize <mt@gitlocalize.com>
Co-authored-by: 织梦 <493733933@qq.com>

* Translate id.yml via GitLocalize (#250)

Co-authored-by: Nathan Adhitya <nathanadhitya@outlook.com>

* Translate fr.yml via GitLocalize (#251)

Co-authored-by: organizatsiya <organizatsiya.wildguns@gmail.com>

* Korean translation (#252)

* Translate ko.yml via GitLocalize

* Translate ko.yml via GitLocalize

Co-authored-by: chickiyeah <ruddls030@naver.com>
Co-authored-by: mt-gitlocalize <mt@gitlocalize.com>

* German Translation (#253)

* Translate de.yml via GitLocalize

* Update de.yml

Co-authored-by: Rikamo045 <rik.amos.krajinovic@gmail.com>
Co-authored-by: tastybento <tastybento@users.noreply.github.com>

* Translate hu.yml via GitLocalize (#254)

Co-authored-by: András Marczinkó <marczinkoandris@gmail.com>

* Version 2.9.1

* Attempt to handle WildStacker spawners

* Fix error lon loading id locale

* Avoid async chunk snapshotting.

Fixes https://github.com/BentoBoxWorld/Level/issues/256

* Update to BentoBox API 1.20.
Replace plugin.yml with spigot-annotations.

Implement customizable TopLevelPanel.

* Fixes some small issues with TopLevelPanel

Add Utils class that contains some useful things.

* Implement customizable DetailsPanel.

Remove old DetailsGUITab due to new implementation.

* Fix failing test.

* Remove blank file

* Added repo for maven plugin snapshots

* Implement feature that allows to sort items in detail panel. (#259)

Apparently, because it is 2 years old request, it got in a state -> implement or drop.

Fixes #192

* Implement calculated value for blocks. (#260)

It is ~ value, as calculation formula cannot be applied per block. At least I think so.

Part of #192

* Update es.yml (#261)

* Implement customizable Values GUI. (#262)

This GUI shows value to all items in game. It also shows max limit of blocks, if it is set.

Fixes of #192

* Support for AdvancedChests was updated. (#266)

* Implements visit/warp actions in top gui

Add 2 new actions for island buttons in TOP GUI:
- Visit -> allows to visit island, but it requires Visit Addon
- Warp -> allows to warp to island, but it requires Warp Addon

Requested via Discord.

* Fixes a Level addon crash on startup.

Level addon crashed at the startup if Visit or Warps addon were not installed. It happened because Level addon main class were implementing Listener interface.
To avoid it and fix the crash, I moved migration listener to a separate class.

Fixes #2012

* Translate pl.yml via GitLocalize (#269)

Co-authored-by: wiktorm12 <wiktorm12@gmail.com>

* Translate fr.yml via GitLocalize (#272)

Co-authored-by: organizatsiya <organizatsiya.wildguns@gmail.com>

* Update to Java 17

* Update Github workflow to Java 17

* Adds %Level_[gamemode]_island_level_max% placeholder

This records the lifetime maximum level the island has ever had.
Addresses #271

* Only shows Members or higher in the top members placeholder

Fixes #267

* Add natural log to level-calc formula parsing

Relates to #274

* feat: add island total points + placeholder (#264)

* feat: add island total points + placeholder

* Update IslandLevels.java

* Fix JavaDoc

* Translate zh-CN.yml via GitLocalize (#276)

Co-authored-by: dawnTak <lanlongxiaode@outlook.com>

* Translate nl.yml via GitLocalize (#277)

Co-authored-by: DevSolaris <solaris.dev.2002@gmail.com>

* Add ${argLine} to get jacoco coverage

* Updated Jacoco POM

* Add shulker to in chest count (#275)

* Sonar Cloud code smell clean up (#278)

* Refactor placeholders (#279)

* Update ReadMe

* Fix Jacoco

* Remove unused imports

* Remove placeholders from main class

Created a separate class for cleaner code and added a test class.

* Remove dependency

* Add UltimateStacker hook for stacked blocks (#281)

* Create plugin.yml (#282)

* Create plugin.yml

The annotations do not provide the option to define the version dynamically from maven. This should fix that.

* Remove Spigot Plugin Annotations

* Remove plugin-annotation repo

* Updated dependencies

---------

Co-authored-by: Huynh Tien <huynhqtienvtag@gmail.com>
Co-authored-by: Rubén <44579213+Rubenicos@users.noreply.github.com>
Co-authored-by: Pierre Dedrie <Pirgosth74@gmail.com>
Co-authored-by: gitlocalize-app[bot] <55277160+gitlocalize-app[bot]@users.noreply.github.com>
Co-authored-by: mt-gitlocalize <mt@gitlocalize.com>
Co-authored-by: 织梦 <493733933@qq.com>
Co-authored-by: Nathan Adhitya <nathanadhitya@outlook.com>
Co-authored-by: organizatsiya <organizatsiya.wildguns@gmail.com>
Co-authored-by: chickiyeah <ruddls030@naver.com>
Co-authored-by: Rikamo045 <rik.amos.krajinovic@gmail.com>
Co-authored-by: András Marczinkó <marczinkoandris@gmail.com>
Co-authored-by: BONNe <bonne@bonne.id.lv>
Co-authored-by: KrazyxWolf <68208993+KrazyxWolf@users.noreply.github.com>
Co-authored-by: DeadSilenceIV <Barreto-h2@hotmail.com>
Co-authored-by: wiktorm12 <wiktorm12@gmail.com>
Co-authored-by: evlad <emmanuelvlad@gmail.com>
Co-authored-by: dawnTak <lanlongxiaode@outlook.com>
Co-authored-by: DevSolaris <solaris.dev.2002@gmail.com>
Co-authored-by: DevSolaris <105156235+DevSolaris@users.noreply.github.com>
Co-authored-by: ceze88 <dev.ceze@gmail.com>
2023-04-15 16:44:33 -07:00

4.4 KiB

Level

Build Status Bugs Reliability Rating Lines of Code

About

Add-on for BentoBox to calculate island levels for BentoBox game modes like BSkyBlock and AcidIsland. It counts blocks and assigns a value to them. Players gain levels by accumulating points and can lose levels too if their points go down. This add-on will work for game modes listed in the config.yml.

Full documentation for Level can be found at docs.bentobox.world.

Official download releases are at download.bentobox.world.

How to use

  1. Place the level addon jar in the addons folder of the BentoBox plugin
  2. Restart the server
  3. The addon will create a data folder and inside the folder will be a config.yml
  4. Edit the config.yml how you want. The config specifies how much blocks are worth (see below)
  5. Restart the server if you make a change

Upgrading

  1. Read the release notes carefully, but you may have to delete the old config.yml to use a new one.

Permissions

Permissions are given automatically to players as listed below for BSkyBlock, AcidIsland and CaveBlock. If your permissions plugin strips permissions then you may have to allocate these manually. Note that if a player doesn't have the intopten permission, they will not be listed in the top ten.

permissions:    
  bskyblock.intopten:
    description: Player is in the top ten.
    default: true
  bskyblock.island.level:
    description: Player can use level command
    default: true
  bskyblock.island.top:
    description: Player can use top ten command
    default: true
  bskyblock.island.value:
    description: Player can use value command
    default: true
  bskyblock.admin.level:
    description: Player can use admin level command
    default: true
  bskyblock.admin.topten:
    description: Player can use admin top ten command
    default: true

Config.yml

The config.yml has the following sections:

  • Game Mode Addon configuration
  • General settings
  • Limits
  • Block values
  • Per-world block values

Game Mode Addon configuration

This section allows you to list which game mode add-ons Level should hook into. Use BentoBox's version command to list the official add-on name.

General Settings

This section defines a number of overall settings for the add-on.

  • Underwater block multiplier - default value = 1. If this value is > 1 then blocks below sea level will have a greater value.
  • Level cost - Value of one island level. Default 100. Minimum value is 1.
  • Level wait - Cool down between level requests in seconds
  • Death penalty - How many block values a player will lose per death. Default value of 100 means that for every death, the player will lose 1 level (if levelcost is 100)
  • Sum Team Deaths - if true, all the team member deaths are summed. If false, only the leader's deaths counts.
  • Max deaths - If player dies more than this, it doesn't count anymore.
  • Reset deaths on island reset
  • Reset deaths on team join

Limits

This section lists the limits for any particular block. Blocks over this amount are not counted. This limit applies to all game modes and is not world-specific. Format is MATERIAL: value

Block values

This section lists the value of a block in all game modes (worlds). To specific world-specific values, use the next section. Value must be an integer. Any blocks not listed will have a value of 0. AIR is always zero. Format is MATERIAL: value.

World-specific block values

List any blocks that have a different value in a specific world. If a block is not listed, the default value will be used from the blocks section. Prefix with world name. The values will apply to the associated nether and the end if they exist. Example:

worlds:
  AcidIsland_world:
    SAND: 0
    SANDSTONE: 0
    ICE: 0

In this example, AcidIsland will use the same values as BSkyBlock for all blocks except for sand, sandstone and ice.