Skip to content

A simple economy plug-in with rich features for endstone server.

License

Notifications You must be signed in to change notification settings

umarurize/UMoney

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

header


UMoney UMoney

Minecraft - Version PyPI - Version

Total Git clones GitHub Downloads (all assets, all releases)

🔔Introductions

  • Rich features:
  • Money pay
  • Money rank
  • Money query (operator)
  • Money change (operator)
  • Money reset (operator)
  • Full GUI: Beautiful GUI forms for easy operation rather than commands.
  • Hot reload support: Operators can edit/update config.json in game directly.
  • Localized languages support

🔨Installation

[Optional pre-plugin] ZX_UI

Put .whl file into the endstone plugins folder, and then start the server. Enter the command /um to call out the main form.

💻Download

Now, you can get the release version form this repo or Minebbs Minebbs.

📁File structure

Plugins/
├─ umoney/
│  ├─ config.json
│  ├─ money.json
│  ├─ lang/
│  │  ├─ zh_CN.json
│  │  ├─ en_US.json

📝Configuration

UMoney allows operators to edit/update config.json through GUI forms with ease, here are just simple explanations for relevant configurations.

money.json just stores simple key-value pairs (key stands for player's name, value stands for player's money)

config.json

{
    "default_money": 5000,  // initial money for a new player
    "money_rank_display_num": 15 // the player amount that the money rank can display
}

money.json

{
    "umaru rize": 113733,
    "minokni": 1200,
    "TheDeerInDream": 10090,
    "SoleWool4183955": 112566,
    "BarrelGold90850": 6020
}

🌐Languages

  • zh_CN
  • en_US

Off course you can add your mother language to UMoney, just creat XX_XX.json (such as ja_JP.json) and translate value with reference to en_US.json.

You can also creat a PR to this repo to make your mother language one of the official languages of UMoney.

💪API

# get all players' money data
self.server.plugin_manager.get_plugin('umoney').api_get_money_data() -> dict

# get the target player's money
self.server.plugin_manager.get_plugin('umoney').api_get_player_money(player_name: str) -> int

# get the richest player's money
# return [player_name: str, player_money: int]
self.server.plugin_manager.get_plugin('umoney').api_get_player_money_top() -> list

# get the poorest player's money
# return [player_name: str, player_money: int]
self.server.plugin_manager.get_plugin('umoney').api_get_player_money_bottom() -> list

# reset the target player's money
self.server.plugin_manager.get_plugin('umoney').api_set_player_money(player_name: str, money_to_set: int) -> None

# change the target player's money
# money_to change cannot be zero
self.server.plugin_manager.get_plugin('umoney').api_change_player_money(player_name: str, money_to_change: int) -> None

📷Screenshots

You can view related screenshots of UMoney from images folder of this repo.

GitHub License

About

A simple economy plug-in with rich features for endstone server.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages