<\/p>\n# Player Events<\/p>\n
\n<\/p>\n
<\/p>\n
**Note: this mod is server side only and won’t work on clients**<\/p>\n
A Fabric mod that executes and sends configurable commands and messages respectively on certain
\nevents triggered by a player, such as Dying, Joining a server, Killing another player, etc.<\/p>\n
**Since 2.2.0** Datapacks can define functions that will be executed on an event, using the corresponding function tag `#player_events: The config file is located in the config directory (`config\/player_events.json`) and looks like this:<\/p>\n “`JSON On the JSON file you can declare, under the `actions` array on each ` **Since 2.2.0** You can choose to randomly send one of the defined messages for a given event by setting `pick_message_randomly` to `true`.<\/p>\n Every event has a `${player}` token, and each instance of this token will be replaced with the player **Supports color codes too!**<\/p>\n Use `\/pe reload` or `\/player_events reload` to reload the mod config.<\/p>\n You can use `\/pe test ### 2.2.0 supported events Additionally, you can create simple commands (if you want a more complex command, this mod isn’t what you ### Troubleshooting ## Developing ### Compiling<\/p>\n 1. Clone or download the repository ### API dependencies { \/\/ Directly setting the version (replace 2.1.3 with the latest release available) Also, add this snippet to your `fabric.mod.json` if you want your mod to depend on the api: #### Events #### Note #### Using the events PlayerKillEntityCallback.EVENT.register((player, killedEntity) -> { Sends a configurable message\/command when a player dies and leaves or joins the server<\/p>\n","protected":false},"featured_media":0,"template":"","meta":{"_minecraft_slug":"player-events","_minecraft_project_id":"NLx6lJPJ","_minecraft_author":"IotaBread","_minecraft_license":"MIT","_minecraft_downloads":9960,"_minecraft_follows":54,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"player-events.zip","_minecraft_size_bytes":2099042,"_minecraft_version_count":49,"_minecraft_updated_at":"2026-05-16T06:15:11.995272Z","_minecraft_date_created":"2020-10-27T15:14:15.246730Z","_minecraft_date_modified":"2023-07-04T02:19:14.721590Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/player-events","_minecraft_icon_attachment_id":0,"_minecraft_imported_at":"2026-06-07T04:46:43+00:00","_minecraft_import_hash":"b565180a1280f9316d0bc409a9f5530f","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,98,92],"mod_loader":[99,100],"minecraft_version":[118,119,120,46,47,48,49,50,51,52,53,54,55,56,57,36],"class_list":["post-122429","mod","type-mod","status-publish","hentry","mod_category-fabric","mod_category-quilt","mod_category-utility","mod_loader-fabric","mod_loader-quilt","minecraft_version-1-16","minecraft_version-1-16-1","minecraft_version-1-16-2","minecraft_version-1-16-3","minecraft_version-1-16-4","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-20-1"],"yoast_head":"\n
\n{
\n “death”: {
\n “actions”: [
\n “${player} just died!”
\n ],
\n “broadcast_to_everyone”: true,
\n “pick_message_randomly”: false
\n },
\n “first_join”: {
\n “actions”: [
\n “Welcome to the server ${player}! Remember to read the rules”
\n ],
\n “broadcast_to_everyone”: false,
\n “pick_message_randomly”: false
\n },
\n “join”: {
\n “actions”: [
\n “Welcome ${player}”,
\n “\/say Hello ${player}”
\n ],
\n “broadcast_to_everyone”: true,
\n “pick_message_randomly”: false
\n },
\n “kill_entity”: {
\n “actions”: [
\n “${player} killed ${killedEntity}”
\n ],
\n “broadcast_to_everyone”: true,
\n “pick_message_randomly”: false
\n },
\n “kill_player”: {
\n “actions”: [
\n “${player} killed ${killedPlayer}”,
\n “F ${killedPlayer}”
\n ],
\n “broadcast_to_everyone”: true,
\n “pick_message_randomly”: true
\n },
\n “leave”: {
\n “actions”: [
\n “Goodbye ${player}!”,
\n “\/say Hope to see you soon ${player}”
\n ],
\n “broadcast_to_everyone”: true,
\n “pick_message_randomly”: false
\n },
\n “custom_commands”: [
\n {
\n “command”: “\/plugins”,
\n “actions”: [
\n “Hey! We don’t use plugins”
\n ],
\n “broadcast_to_everyone”: false,
\n “pick_message_randomly”: false
\n },
\n {
\n “command”: “\/spawn”,
\n “actions”: [
\n “\/tp ${player} 0 64 0 0 0”
\n ],
\n “broadcast_to_everyone”: true,
\n “pick_message_randomly”: false
\n }
\n ]
\n}
\n“`<\/p>\n
\nto be sent and\/or executed on that event. You can also set these messages to be sent only to the
\nplayer by setting `broadcast_to_everyone` to `false`, but this won’t work with events like `leave`
\n(because the player isn’t in the server anymore).<\/p>\n
\nthat triggers the event. Other events have extra tokens that work the same way.
\nMost (if not all) tokens have properties that can be accessed with something like `${player.name}`.
\nHere is a list of all the properties:
\n– `display`
\n Entity’s display name, the one you see in the player list\/chat. Example: “[Team blue] Tom421”
\n– `uuid`
\n Entity’s UUID
\n– `x` `y` `z`
\n Entity coordinates
\n– More coming soon\u2122<\/p>\n
\nevent, or use `\/pe test *` to test every event.<\/p>\n
\n* `death` – Executed when a player dies.
\n* `first_join` – Executed when a player joins for first time.
\n* `join` – Executed when a player joins.
\n* `kill_entity` – Executed when a player kills an entity. Extra tokens:
\n * `${killedEntity}` – the killed entity.
\n* `kill_player` – Executed when a player kills another player. Extra tokens:
\n * `${killedPlayer}` – the killed player.
\n* `leave` – Executed when a player leaves.
\n* `custom_commands` – Custom defined events triggered by using a defined command. **Note: This event does not support datapack functions**<\/p>\n
\nare looking for) or listen to existing ones.<\/p>\n
\nIf you get an error when initializing the server or when an action should be executed, here are
\nsteps on how to solve it.
\n– “Invalid JSON syntax in the config file”: This is most likely caused by having a command with
\n unescaped double quotes. To fix it:
\n 1. Check what the exception says in the line below. It will indicate exactly where the error is.
\n 2. Escape any double quotes inside the action with backslashes like `”` -> `”`
\n– “Invalid escape sequence”
\n This is caused because of an improperly escaped escape sequence like `n` or `u`. To fix it,
\n just add a backslash before the escape sequence backslash, for example `n` -> `\\n` or `\\u` -> `\\\\u`<\/p>\n
\nThis part is for mod developers that would like to use the mod api.<\/p>\n
\n2. On a command prompt run `gradlew build` to compile the mod. (If you only need the API files,
\n you can run `gradlew api:build` instead) . You’ll find the compiled `.jar` files under
\n `
\n#### Adding the API as a dependency of your mod
\nAdd the following snippet to your `build.gradle`:
\n“`groovy
\nrepositories {
\n maven {
\n url ‘https:\/\/maven.bymartrixx.me’
\n }
\n}<\/p>\n
\n \/\/ Using the version from the gradle.properties
\n modImplementation “me.bymartrixx.player-events:api:${project.player_events_api_version}”<\/p>\n
\n modImplementation “me.bymartrixx.player-events:api:2.1.3”
\n}
\n“`
\nAdd this snippet to your `gradle.properties` if you aren’t directly setting the version to the build.gradle file:
\n“`properties
\n# Replace 2.1.3 with the latest release available
\nplayer_events_api_version = 2.1.3
\n“`<\/p>\n
\n“`json
\n{
\n “depends”: {
\n “player_events_api”: “>=2.0.0”
\n }
\n}
\n“`<\/p>\n
\n* `death` – `me.bymartrixx.playerevents.api.event.PlayerDeathCallback.EVENT`
\n* `first_join` – `me.bymartrixx.playerevents.api.event.PlayerFirstJoinCallback.EVENT`
\n* `join` – `me.bymartrixx.playerevents.api.event.PlayerJoinCallback.EVENT`
\n* `kill_entity` – `me.bymartrixx.playerevents.api.event.PlayerKillEntityCallback.EVENT`
\n* `kill_player` – `me.bymartrixx.playerevents.api.event.PlayerKillPlayerCallback.EVENT`
\n* `leave` – `me.bymartrixx.playerevents.api.event.PlayerLeaveCallback.EVENT`
\n* Command executed – `me.bymartrixx.playerevents.api.event.CommandExecutionCallback.EVENT`<\/p>\n
\nThe package
\n`io.github.bymartrixx.playerevents.api` has been removed in 2.2.0.<\/p>\n
\nExample snippet
\n“`java
\npublic class FooMod implements DedicatedServerModInitializer {
\n public void onInitializeServer() {
\n PlayerDeathCallback.EVENT.register((player, source) -> {
\n \/\/ Do something
\n });<\/p>\n
\n \/\/ Do something
\n });
\n }
\n}
\n“`<\/p>\n","protected":false},"excerpt":{"rendered":"