Skip to content

GUI items example

Paolo edited this page Jul 17, 2017 · 11 revisions



Sample configurations for the items in the gui

These examples can be set via https://gist.github.com/itpao25/0885f3a9875bbcfc1ef6#file-config-yml-L46, under the heading "item"




Options

OPTION - General reports (report-general)

Users can report a problem without indicating the offending player.
Using the command /report * will open the classic gui.
You can specify which items are to be displayed for this type of report using the option report-general.

Example:

   grief-general:
      slot: 4
      motivation: 'grief in the world (%world_from%)'
      action: report
      report-general: true
      name: '&e&o&lReport a grief'
      permission: 'Reportergui.use'
      lore:
      - '&2Report a grief in the world'
      itemtype: TNT
      amout: 0

OPTION - Saves the coordinates (save-coords)

It's possibile save the coordinates where the player has sent the report.
Using the option save-coords it will be possible reach the coords where the player has set the report.

Example:

   grief-general:
      slot: 4
      motivation: 'grief in the world (%world_from%)'
      action: report
      report-general: true
      save-coords: true
      name: '&e&o&lReport a grief'
      permission: 'Reportergui.use'
      lore:
      - '&2Report a grief in the world'
      itemtype: TNT
      amout: 0

OPTION - Auto expiration (expire-time)

It's possibile set a report as expired automatically.
More information: https://github.com/itpao25/ReporterGUI/wiki/Automatic-expiration-system

Example:

   grief-general:
      slot: 4
      motivation: 'grief in the world (%world_from%)'
      action: report
      # auto expire after 5 minutes
      expire-time: 5
      name: '&e&o&lReport a grief'
      permission: 'Reportergui.use'
      lore:
      - '&2Report a grief in the world'
      itemtype: TNT
      amout: 0

The option expire-time is mean as minutes after that the report is executed.
If you want that the report will be set as expired after 1 day you must set expire-time to 1440

Actions

  • close - this action allows you to close the gui, then return to game
  close: 
    slot: 26
    action: close 
    name: '&c&lClose'
    lore:
    - '&cBack to the game'
    id: '35:14'
    amout: 0
  • report - send a report (default)
  use-killaura: 
    slot: 0
    action: report
    name: '&c&o&lUsing killaura'
    lore:
    - '&c>&9>&c> &2&oReport this player for use killaura'
    id: 347
    enchant: KNOCKBACK, 2
    amout: 2
  • nothing - nothing (only for decoration)
  use-killaura: 
    slot: 0
    action: nothing
    name: '&c&o&lUsing killaura'
    lore:
    - '&c>&9>&c> &2&oReport this player for use killaura'
    id: 347
    enchant: KNOCKBACK, 2
    amout: 2

Item & lore

You can customize the items, through lore and id.
Reportergui also supports sub id, eg 35:14 for colored wool

Reason

With the type of action report, it's possible set a motivation for the report
Example: motivation: Usage killaura

Variable for report

  • %playertarget% - returns with the name of the player reported
  • %fromplayer% - returns with the name of the player who execute the report
  • %coord_from% - returns with coordinates of the player who execute the report
  • %coord_reported% - if the player reported is online, returns with it coordinates
  • %world_reported% - if the player reported is online, returns with the name of world where is the player
  • %world_from% - returns with the name of world where is the player who execute the report

Example: `motivation: 'it is doing a grief (%coord_reported%)'`
Output: `IPv4 it was reported by itpao25 for is doing a grief (plot_world : 120x : 72y : -83z)`