Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/plexi09/argus


https://github.com/plexi09/argus

Last synced: 28 days ago
JSON representation

Awesome Lists containing this project

README 

        
# Argus Plugin



*Moderator Utilities for the Sunrise Network*



---



## Introduction



**Argus** is a powerful moderation utility plugin designed to assist moderators on the **Sunrise Network**. It provides a suite of commands to help maintain order and fairness in the game.



---



## The Mythological Background of Argus



In Greek mythology, **Argus Panoptes** was a giant with a hundred eyes. Known for his vigilance, Argus was an all-seeing guardian, often depicted as a watchful protector who never slept. At any given time, some of his eyes were always open, ensuring nothing escaped his notice.



### Why "Argus"?



The name **Argus** was chosen for this plugin to symbolize its purpose and functionality:

- **Vigilance**: Just like Argus, the plugin keeps a constant watch over the server, monitoring player activities and inventories.

- **All-seeing**: With its comprehensive suite of commands, Argus allows moderators to observe and manage the server effectively, ensuring a fair and safe environment for all players.



---



## Disclaimer



**Argus is not an anti-cheat plugin.** While it provides tools for moderators to monitor player activities and detect suspicious behavior, it does not automatically prevent or detect cheating. For effective server management, it is recommended to use Argus in conjunction with dedicated anti-cheat plugins.



---



## Main Features



- **`/topluck`**: Displays the "luckiest" players. Useful for identifying potential xrayers.

- **`/openinv`**: Opens a player's inventory.

- **`/openender`**: Opens a player's ender chest.

- **`/searchinv`**: Lists all players who possess a specified item in their inventory.

- **`/searchender`**: Lists all players who possess a specified item in their ender chest. *(Work in Progress)*

- **`/silentcontainer`**: Enables or disables SilentContainer mode. *(Work in Progress)*

- **`/arrest`**: Arrests a player with a given reason.

- **`/spectate`**: Puts the moderator in spectator mode and teleports to another player.



---



## Commands Breakdown



### `/topluck`



- **Description**: Displays a list of the "luckiest" players on the server.

- **Use Case**: Helps in detecting players who might be using xray mods by tracking their unusual luck in finding valuable resources.



### `/openinv `



- **Description**: Allows moderators to open and view the inventory of a specified player.

- **Use Case**: Useful for checking if a player possesses any illegal or suspicious items.



### `/openender `



- **Description**: Opens the ender chest of a specified player for viewing.

- **Use Case**: Provides moderators with the ability to check hidden items stored in a player's ender chest.



### `/searchinv `



- **Description**: Lists all players who have a specific item in their inventory.

- **Use Case**: Helps track down items of interest or identify players in possession of prohibited items.



### `/searchender `



- **Description**: Lists all players who have a specific item in their ender chest. *(Work in Progress)*

- **Use Case**: Similar to `/searchinv`, but for ender chests. Useful for extended search capabilities.



### `/silentcontainer`



- **Description**: Toggles SilentContainer mode. *(Work in Progress)*

- **Use Case**: When enabled, this mode allows moderators to access containers silently without alerting the player.



### `/arrest  `



- **Description**: Arrests a specified player for a given reason.

- **Use Case**: Enforces rules by temporarily detaining players who violate server regulations.



### `/spectate `



- **Description**: Switches the moderator to spectator mode and teleports them to a specified player.

- **Use Case**: Allows moderators to observe a player's activities without being detected.



---



## Future Enhancements



We are continually working to improve Argus. Upcoming features include:



- **Advanced search filters for inventories and ender chests.**

- **Enhanced SilentContainer functionalities.**

- **Additional commands for better moderation control.**



---



## Contributions



We welcome contributions from the community! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request on our [GitHub repository](#).



You can compile with this Maven goal: `mvn clean package`



---



**Stay vigilant, moderators!** With Argus, maintaining a fair and enjoyable game environment on the Sunrise Network has never been easier.



---