Giter VIP home page Giter VIP logo

griefalert's Introduction

GriefAlert

A grief alerting plugin for MinecraftOnline, built on Sponge in combination with Prism, WorldEdit, and Holograms.

Commands

All commands have a subcommand help | ? to display usage and further subcommands.

  • /griefalert | ga ...
    • Central command for GA. By default, displays welcome splash screen
    • reload
      • Reload the configuration file and the Grief Profile database into server memory
    • check | c <index>
      • Investigate an Alert at index
      • Bestows temporary invulnerability
    • return | r
      • Return to the previous known location prior to an Alert check
    • info | i <index>
      • Send detailed information about the Alert at index through chat
    • show | s <index>
      • Display an informative hologram at the location of the Alert at index
    • fix | f <index>
      • Attempt to rollback a specific index to its previous state
    • query | q [flags...]
      • Filtering with specific flags, query the Alert cache
      • Flags: Partial Username, GA Event, Partial Target, Maximum, Spread, Group
    • profile | p
      • add | a <event> <target> [flags...]
        • Adds a Grief Profile to the database.
        • event: GA Event
        • target: GA Target
        • flags: Ignore, Event Color, Target Color, Dimension Color
      • remove | r <event> <target>
        • Removes a Grief Profile to the database.
        • event: GA Event
        • target: GA Target
      • count | c
        • Returns the total number of Grief Profiles currently in use.
      • list | l
        • List all Grief Profiles currently in use
      • events
        • List all GA Events
    • logs | l ...
      • inspect | i
        • Enable or disable Prism's inspector tool
        • Same command as Prism's "/pr i"
      • [flags...]
        • Filtering with specific flags and a selected WorldEdit region, query the all Prism logs
        • Flags: Time Since, Time Before, Exact Username, Prism Target, Prism Event, and Group
    • rollback | rb ...
      • Filtering with specific flags and a selected WorldEdit region, rollback all events stored in Prism to original state
      • Flags: Time Since, Time Before, Exact Username, Prism Target, and Prism Event
    • restore | rs ...
      • Filtering with specific flags and a selected WorldEdit region, restore all events stored in Prism to more recent state
      • Flags: Time Since, Time Before, Exact Username, Prism Target, and Prism Event
    • flush
      • Removes all cached Alerts

Argument Syntax

Symbol Meaning
<...> required
[...] optional

Flags/Parameters

These are the flags and parameters available for commands. Only if the specified flag requirements are satisfied will a query returned to the executor.

Name Label Explanation
Alert Index index Integer corresponding to location of Alert in cache
Maximum max Self-explanatory
Time Since since (Date Format) The earliest date in a range
Time Before before (Date Format) The latest date in a range
Exact Username player Exact (case-sensitive) username
Partial Username player A substring of a username
Prism Target target The exact Minecraft ID of an object. This includes the domain, i.e. "minecraft:", except entities.
GA Target target The Minecraft ID of an object. Domain specification "minecraft:" is implied and not necessary.
Partial Target target A substring of any Minecraft ID
Prism Event event The name indicative of the type of event. Event types: {break, decay, grow, place, death, command, close, open, drop, insert, pickup, remove, disconnect, join}
GA Event event The name indicative of the type of event. Event types: {break, place, death, use, apply, interact, attack, replace}
Dimension dimension {minecraft:overworld, minecraft:nether, minecraft:the_end}
Ignore ignore A world name such that the world is ignored
(...) Color ..._color Specifies the color for a specific portion (...) of text. Color types: {black, dark_blue, dark_green, dark_aqua, dark_red, dark_purple, gold, gray, dark_gray, blue, green, aqua, read, light_purple, yellow, white}
Spread spread Return all results of a query separately
Group group Return all results of a query collapsed together where possible

Date Format

The output format for dates/times can be defined in the configuration file.

The input syntax for dates/times can be done in one of two ways: Either use the format "yyyy-MM-dd" to establish the exact day or give a time period to subtract from the current time. The time period is formatted using a series of integer values, each combined with a symbol corresponding to the time unit.

Symbol Time Unit
s Second
m Minute
h Hour
d Day
w Week
M Month
y year

Examples

Format Meaning
1d12h 1 day and 12 hours ago
2w5d 2 weeks and 5 days ago
10m1h1d 1 day, 1 hour and 10 minutes ago

Old Commands

MinecraftOnline used to have different commands associated with the older version of GriefAlert. The following commands have been changed:

<1.7.10 >1.12.2
/gcheck /ga c
/grecent /ga q

Permissions

Permission Effect
griefalert.messaging Receive Alert messages
griefalert.silent Alerts originating from this player are muted
griefalert.command Access to /ga
griefalert.command.check Access to /ga c
griefalert.command.info Access to /ga i
griefalert.command.show Access to /ga s
griefalert.command.query Access to /ga q
griefalert.command.fix Access to /ga f
griefalert.command.reload Access to /ga reload and /ga flush
griefalert.command.profile Access to /ga p
griefalert.command.logs Access to /ga l
griefalert.command.rollback Access to /ga rb and /ga rs

Definitions

  • Profile: GriefAlert decides which alerts to create and send to staff members by checking if certain events--thrown either directly through Sponge or indirectly through Prism--match a specific Profile. The database of Profiles can be managed with /ga p.
  • Alert: Alerts are objects created when an event matches a Profile. When an Alert is created, the information within are then formatted in a variety of ways and sent to staff members.

Contributors

  • PietElite: Creator of Sponge GriefAlert and current model
  • darkdiplomat: Worked on original model
  • BastetFurry: Worked on original model
  • 14mRh4X0r: Worked on original model

griefalert's People

Contributors

14mrh4x0r avatar darkdiplomat avatar ejm avatar tyhdefu avatar whimxiqal avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

tyhdefu

griefalert's Issues

Porting to Sponge API 8 and GriefAlert v2.0.0

The gargantuan task will also include the re-organization of GriefAlert and Prism to be combined into a single GriefAlert v2.0.0 plugin. It will have the following steps:

  • Move Prism into the repository and reorganize file structure to accommodate the influx of content
  • Fix all the errors by fixing imports, combining files and behavior
  • Ensure that the common subdirectory has no mention to Minecraft or Sponge (for organizational purposes and behavior separation) and move things to the sponge subdirectory as needed
  • Ensure all behavior in the sponge subdirectory cannot be abstracted to the common subdirectory by removing any mention of Minecraft or Sponge
  • Bump Sponge API version to 8 and port existing code to new Sponge API

All work to be done in #4

The flag "after (-a)" in logs subcommand is still (-s)

I changed all flags in the logs, rollback, and restore subcommands to use -a, as in "after" instead of -s, as in "since" because I thought that "after" makes more sense to represent that you want to be asking about a timeframe "after" a certain date. But, the flag in the logs subcommand is still -s, while the help menu states that is is -a (which it should be).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.