Skip to content
presentkim-pmPublic

About

Immersive AFK mining that a cinematic viewing experience.

Resources

Stars

7 stars

Watchers

0 watching

Forks

Repository files navigation

Version Stars License


Logo

AFKMine

Immersive AFK mining with a cinematic camera experience.

Korean README · Report a bug · Request a feature

About The Project

This plugin is a PoC made to test the CameraAPI plugin and the virions.

✔️ Create AFK mines in-game
✔️ Watch a dummy miner mining ores via a cinematic camera path
✔️ Receive real drops as rewards over time
✔️ Supports multilingual messages and localized default config via libmultilingual
✔️ Restores original blocks when deleting a mine


Requirements

  • PocketMine-MP 5.x
  • PHP 8.2


Dependencies

  • CameraAPI (plugin dependency)
  • Virions used by this plugin:
    • session-utils
    • selection-visualize-utils
    • play-sound-utils
    • libmultilingual
    • player-state-backup


Commands & Permissions

  • /afkmineadmin (permission: afkmine.command.admin, default: OP)
    • create : enter mine creation mode
    • list : list registered mines
    • delete <name> : delete a mine by name (restores original blocks for its ore spots)
  • /afkmine (permission: afkmine.command.user, default: true)
    • join/leave an available AFK mine session


Usage

Create a mine (/afkmineadmin create)
KakaoTalk_20260311_191043959.mp4
  1. Your inventory will be replaced with creation tools.
  2. Touch blocks / use items to set positions:
    • Ore spot tools (slot 1–3): add/remove ore spots by preset (Stone/Nether/Deepslate)
    • Dummy spawn position
    • Camera position (look-at) (can be added multiple times)
    • Player hide position
    • Save and exit
  3. In the save form, set:
    • mine name
    • ore regen interval (ticks)
Join AFK mining (/afkmine)
KakaoTalk_20260311_191053714.mp4
  • Start/stop an AFK session in an available mine.
  • Rewards are settled every reward-interval seconds.


Ore presets

Default presets are registered in OrePresetRegistry:

  • IDs: stone, nether, deepslate
  • Names are localized via libmultilingual keys:
    • afkmine.orePreset.stone
    • afkmine.orePreset.nether
    • afkmine.orePreset.deepslate

You can override presets by registering a new OrePreset with the same ID.


Multilingual support

Messages

  • Resource locale files:
    • resources/locale/eng.ini (required)
    • resources/locale/kor.ini
  • Server owners can edit messages in:
    • plugin_data/AFKMine/locale/*.ini

Localized default config

  • Resource configs:
    • resources/config/eng.yml (required)
    • resources/config/kor.yml
  • On first run (or if plugin_data/AFKMine/config.yml is missing), the plugin saves the server-language matching config to:
    • plugin_data/AFKMine/config.yml


World restore on mine delete

When you mark blocks as ore spots during creation, AFKMine stores the original block state IDs. When the mine is deleted (/afkmineadmin delete <name>), it restores those blocks so the world returns to its previous state instead of leaving regenerated ores/base blocks behind.


Installation

  1. Download plugin .phar releases (or install from source for PoC testing)
  2. Move downloaded .phar file to server's /plugins/ folder
  3. Restart the server


License

See the repository license file for more information.


About

Immersive AFK mining that a cinematic viewing experience.

Resources

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages