Flags

Flags Logo

Flags is an interface plugin designed to bridge the gap between cuboid and other land management plugins and other plugins that would need to access them.

Based on similar concepts of Vault, Flags provides a single unified object or "Area" for developers to have basic access to the information it holds without the need to know which plugin created it. This allows developers to implement per-area features one time and have them work automatically with all the supported land management plugins.

Though it has grown far beyond it's original purpose, Flags gets it's name from it's ability to allow plugins to create "flags" or switches that change the behavior of the game or plugin in specific areas. Flags will automatically maintain the users choices and customizations, and the plugins that created the flags merely have to handle their behavior. Don't let the name fool you, plugins can use the API for hooking into areas without actually creating flags at all.

Commands Configuration Permissions Area Plugins Frequently Asked Questions Developer API

Features

  • Multiple land area plugin support
  • Modular flags allow you to choose only what you want.
  • Developer API allows anyone to create flag plugins or interface with areas.
  • Flags can be set for areas, the wilderness, or new area defaults.
  • Trust lists allow you to choose players that can bypass flag effects in each area.
  • Customizable player messages allow you to personalize all player flags per area.
  • Customizable flag bundles allow you to set multiple flags in a single command.
  • Multi-world support allows you to treat each world as a different area, including the wilderness and defaults.
  • YAML and MySQL data storage options for flexible servers
  • Vault economy support for purchasing flags and messages

Supported Area Plugins (optional)

Flags currently supports Factions, Factoid, Grief Prevention, InfinitePlots, PlotMe, PreciousStones, Residence, and WorldGuard. Flags also has an internal system it uses if no other system is detected. For more details on compatibility and feature sets, please visit the Area Plugins page.

Plug-ins and Modules

Included Modules

Included with Flags is a set of optional flag modules available that operate with just Bukkit. To install them, place the modules you want to use in your plugins folder, along with Flags.jar.

ModuleDescription
Block ModuleAdds flags based on block control.
Border Patrol ModuleAdds flags based on players moving into or out of an area.
Core ModuleAdds general flags that don't fit with any of the other included modules.
Creature Spawn ModuleAdds flags for stopping creatures from spawning.
Damage ModuleAdds flags for stopping types of player damage.
Player ModuleAdds flags based on player actions.
Vehicle ModuleAdds flags based on boats, minecarts, and horses.

External Plugins and Modules

Below is a list of known plugins and modules not included with Flags that add their own flags. If you have developed a plugin with Flags support or a module and want it listed here, add a post to the developer forum!

PluginDescriptionFlags
BlockNotifNotifies moderators when players break certain blocks, logs it, and prevents it from occurring.None. Flags is used to report the name or ID of the area defined by the system your using.
FancyShopCreates chest shops that trade in physical currencies.Flags that allow shops to be restricted to specific areas.
FlyNCreativeAllows server operators to set areas where creative mode and flight are enabled while maintaining inventories for those areas.Flags to select Flight and/or Creative mode.
HardcoreClaimsGrief Prevention extension that deletes claims and restores the land when a player dies.Flags for choosing which claims get deleted and what areas players must die in to cause a deletion.
PetStoreManage ownership of tameable animals.Flags for choosing where animals can be left for sale, give away, or released.
RocketTeleportPlugin that adds a new flare to warping/teleporting.Flags for choosing where players can create rockets and landing zones.

Flag Usage

NEW: Tutorial: Understanding Area, Wilderness, and Default

To set flags for an area, simply stand inside the area that you would like to set a flag for and issue the command /flag <action> <location> <flag> [value]. For more detailed information, consult the Commands page. Setting a default flag allows you to choose the behavior for all areas in the world that have not had a value previously set. Setting a wilderness flag allows you to choose the behavior for unclaimed areas.

The following examples can be used for the flag or bundle command and can be used with area, default, or wilderness. This is not an exhaustive list.

CommandEffect
/flag get area PvpRetrieves the value of the flag
/flag set wilderness NotifyExit trueExplicitly set the value of the flag.
/flag set default SpawnMobToggle the current value of the flag.
/flag helpDisplay a list of available flags

Tools

Flags has the ability to use item based tools for some functionality. The items are configurable in config.yml. Below is a list of the tools available.

ToolDefaultFunction
FlagQueryFeatherRight click in an area to view the flags currently set. Performs the same function as /flag get area or /flag get wilderness.
SectorGold HoeIf Sectors are enabled, use this tool to create a sector by right clicking to set the corners. Create subdivisions in the same manner inside an existing sector.

Bundles

Bundles allow you to group flags together so you can set them with a single command. New bundles can be added by command or by the server operator editing the bundle.yml file. Bundles maintain their own permissions system, they do not require a flag permission even if the flag is in the bundle. Below is a list of default bundles which serve as examples and can be edited or removed. These bundles will only function if their respective modules are installed.

IMPORTANT: When adding new bundles by editing the file directly, the name should ALWAYS be lower case. Flag names are not case sensitive, and using or adding bundles with commands in-game are not case sensitive. You may use in-line YAML list format if you wish.

BundleFlags
BuildCreatureBuildGolem, BuildSnowman, BuildWither
JailAllowEntry, AllowLeave, AllowTpIn, AllowTpOut
NotifyNotifyExit, NotifyEnter
SpawnMonsterSpawnInvasion, SpawnJockey, SpawnLightning, SpawnMob, Spawner, SpawnChunk, SpawnOther
DamageDamageBlockExplode, DamageContact, DamageDrown, DamageFall, DamageBlockFall, DamageFire, DamageBurn, DamageLava, DamageLightning, DamageMagic, DamageMelting, DamagePoison, DamageStarve, DamageSuffocate, DamageSuicide, DamageThorns, DamageVoid, DamageWither, DamageOther

Updater

Flags contains an automated updater feature that can check for updates and notify the console and players with permission when one is available. For more information on configuring or disabling the updater, click see the Configuration page.

Metrics

Flags reports non-identifying information about your server to MCStats.org. For more information on what is reported and how to disabled it if you would like to, please see the Questions page. To view the full set of data, click the graph below.

Metrics Graph

Discussion Forum

In order to provide more centralized and effective means of feedback and support for my growing list of plugins, a Discussion Forum has been provided. You don't even need a new account to use it! Please understand that I may not directly respond to comments on this page and I will not respond to plugin questions in the form of PM's. By posting on the forums you help others find answers to the same questions, and I don't have time to continually repeat the same answers if you want new features added! This forum is exclusively for plugins by Alshain01 and discussion of their use and development. For other concerns, please consult the Bukkit Forums.

https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of Alshain01 Alshain01 Aug 30, 2014 at 22:53 UTC - 0 likes

    @mattymaats: Go

    Like a Use Item flag? I don't have one in the plugin right now. I could add it fairly easily. Main reason it's not there is most anti-grief plugins (including Grief Prevention) typically do this already.

  • Avatar of mattymaats mattymaats Aug 30, 2014 at 13:31 UTC - 0 likes

    Hi Alshain01,

    I need a little bit of help here, basically I'm trying to find something that would stop people who are not trusted or owners of a GP claim from right clicking inside the claim with items, would this plugin be able to do that?

    Regards, Matty

  • Avatar of Alshain01 Alshain01 Aug 29, 2014 at 13:18 UTC - 0 likes

    @GodsDead: Go

    The donate button at the top of the page is optional and to date, it's has had 0 uses. Donating here is appreciated, but it does not give you a better plugin. Not dontating does not give you a worse one.

    I never said you were a bad guy, just that I'm not willing to assist someone in breaking the EULA. Your server is your business and you can do whatever you want, but you asked if I would help and the answer is no, and I gave you a reason the answer was no. If your offended by that, sorry, doesn't change anything.

  • Avatar of Alshain01 Alshain01 Aug 29, 2014 at 05:04 UTC - 0 likes

    @GodsDead: Go

    No I don't have any idea how to accomplish that really, and to be honest this is the exact kind of thing Mojang re-wrote their EULA to prevent. You can charge for things, as long as they don't affect gameplay. PvP is gameplay. If you do, your breaking the EULA and are subject to Mojang's wrath.

    https://mojang.com/2014/06/lets-talk-server-monetisation/

    Last edited Aug 29, 2014 by Alshain01
  • Avatar of GodsDead GodsDead Aug 29, 2014 at 01:05 UTC - 0 likes

    Hey, I have a bit of a complex problem im trying to solve, I want to have it so a player has access to one specific command. /flag set area pvp off/on. Now, I only want them to be able to use it once per time, the idea is I have a donate to make a claim PVP free, So it would need to add a token of sorts, or a variable somewhere to state that the player has a token to spend to make a claim PVP free. The long term idea would be to have this work with many types of claim flags, and be size dependant, but thats really getting ahead of the ball, i know there are skript and mycommand this might work with, do you have any ideas how I could make this work?

  • Avatar of Alshain01 Alshain01 Aug 22, 2014 at 22:16 UTC - 0 likes

    @pabstinator: Go

    Well there is no way right now. I don't have any flags directly for GriefPrevention functions. The API would certainly allow it, Flags would need to be configured for WorldGuard, not GriefPrevention. By default the list is alphabetical to avoid claims of bias so you just have to put WG first in the detection list.

    However, you might want to seek out another developer to make a module for that. I can say that I won't have time to add something that isolated to a specific pair of systems.

  • Avatar of pabstinator pabstinator Aug 22, 2014 at 04:38 UTC - 0 likes

    Hi There,

    I've been pondering this for a bit and though it time to ask. Will Flags help me do the following:

    I have GriefPrevention and Worldguard. I have a region called town. I want default users to only be able to claim land in town. Beyond town, claiming land is disabled. Can I set some sort of flag in the world to deny making claims unless in the region called town?

    Thanks in advance!

  • Avatar of Duffa13 Duffa13 Aug 13, 2014 at 13:40 UTC - 0 likes

    @Alshain01: Go

    Thank you for your reply! I really appreciate it. I have decided not to use the plugin after all even though some of the features were really cool. Thank you for your assistance :)

  • Avatar of Alshain01 Alshain01 Aug 11, 2014 at 19:10 UTC - 0 likes

    @Duffa13: Go

    Pvp is tricky, It doesn't turn on PvP, it turns it off. That means you have to have the whole server enabled for PvP in the usual means and then use the flag to turn it off where you want. The API doesn't allow me to detect when non-damage occurs because PvP is off, it only allows me to detect damage to a player caused by another player and then I have the option of cancelling that damage.

    Trapdoor works just fine for me. Can you provide more info?

    The most likely cause of lag is the Border Patrol features, which are controlled by the PlayerMoveEvent. This event is notorious for lag because it fires everytime a player touches the mouse or moves in any direction (changing your view is considered movement in Minecraft so you don't have to actually take any steps) it fires that event which must be processed. Flags tries to limit this by "skipping" some of the events, that is it does a quick check to see if it should skip and then doesn't process the rest of the code. You can increase the amount of skipped events or disable it entirely. More information on that by clicking the Configuration button at the top.

  • Avatar of Duffa13 Duffa13 Aug 11, 2014 at 09:32 UTC - 0 likes

    Some of the flags such as PVP true do not seem to work & trapdoor false. Also when I had this plugin enabled my server experienced massive lag spikes which then caused time out errors.

What is your favorite flag module?

  1. Choice:

  1. Results
  2. 0 comments

Facts

Date created
Sep 04, 2013
Categories
Last update
May 03, 2014
Development stage
Release
Language
  • enUS
License
Creative Commons Attribution-NonCommercial 3.0
Curse link
Flags
Downloads
6,444
Recent files

Authors