Plugin:Bolt - Revision history

BakiDance: /* Examples */

2024-09-03T20:33:52Z

Examples

← Older revision		Revision as of 20:33, 3 September 2024
Line 186:		Line 186:

	==Examples==		==Examples==
			{{Rules
			\| title = Bulk-edit multiple containers
			\| body = <nowiki></nowiki>
			{{CMD\|bolt mode persist}} then type your desired command and click each container.
			}}
	{{Rules		{{Rules
	\| title = Allow players to see the contents of a chest, but not add or remove items		\| title = Allow players to see the contents of a chest, but not add or remove items

BakiDance at 22:53, 31 August 2024

2024-08-31T22:53:08Z

← Older revision		Revision as of 22:53, 31 August 2024
Line 12:		Line 12:
	{{Hatnote\|{{Icon\|notice}} Players are required to be at least [[Plugin:Levels\|Level]] 1 in order to access these features.}}		{{Hatnote\|{{Icon\|notice}} Players are required to be at least [[Plugin:Levels\|Level]] 1 in order to access these features.}}

	'''Bolt''' is a single-block and entity protection plugin used on some servers within the {{SITENAME}} Network. Bolt automatically protects [[Plugin:Bolt/Default Protections\|most blocks]] placed by players with [[~~prism~~:Levels\|level 1]]. Similar to how [[Plugin:GriefDefender\|GriefDefender]] allows players to create and manage land claims, Bolt enables players to manage their individual block protections to modify behaviors, trust other users, and manage access.		'''Bolt''' is a single-block and entity protection plugin used on some servers within the {{SITENAME}} Network. Bolt automatically protects [[Plugin:Bolt/Default Protections\|most blocks]] placed by players with [[Plugin:Levels\|level 1]]. Similar to how [[Plugin:GriefDefender\|GriefDefender]] allows players to create and manage land claims, Bolt enables players to manage their individual block protections to modify behaviors, trust other users, and manage access.

	When blocks protected with Bolt are located on GriefDefender claims, the land claim protection settings always take priority. Players and staff should be mindful of which system is managing access for a given block, and adjust the protection(s) accordingly. As is the case with land claims, Bolt protections expire after 120 days of inactivity<sup>[''See notes'']</sup>.		When blocks protected with Bolt are located on GriefDefender claims, the land claim protection settings always take priority. Players and staff should be mindful of which system is managing access for a given block, and adjust the protection(s) accordingly. As is the case with land claims, Bolt protections expire after 120 days of inactivity<sup>[''See notes'']</sup>.

BakiDance: /* Examples */

2024-07-21T20:06:48Z

Examples

← Older revision		Revision as of 20:06, 21 July 2024
Line 186:		Line 186:

	==Examples==		==Examples==
			{{Rules
			\| title = Allow players to see the contents of a chest, but not add or remove items
			\| body = <nowiki></nowiki>
			{{CMD\|bolt lock display}}
			}}
	{{Rules		{{Rules
	\| title = Trust multiple people on some containers		\| title = Trust multiple people on some containers

BakiDance at 20:08, 10 July 2024

2024-07-10T20:08:07Z

← Older revision		Revision as of 20:08, 10 July 2024
Line 18:		Line 18:
	Bolt is a core plugin on {{SITENAME}}. Generally speaking, this means that the network can't update unless this plugin is also updated and working. Bugs impacting this plugin are considered severe.		Bolt is a core plugin on {{SITENAME}}. Generally speaking, this means that the network can't update unless this plugin is also updated and working. Bugs impacting this plugin are considered severe.

	==Features==		== Features ==
	*Protects both blocks and entities		*Protects both blocks and entities
	*Allows locking of almost any block		*Allows locking of almost any block
Line 25:		Line 25:
	*Set blocks to require password for access		*Set blocks to require password for access

	==Configuring protections==		== Configuring protections ==
	===Protection types===		=== Protection types ===
	Protections types determine how other players should be allowed to interact with a locked container.		Protections types determine how other players should be allowed to interact with a locked container.
	{{Component/section\|		{{Component/section\|
Line 59:		Line 59:
	}}		}}

	===Access types===		=== Access types ===
	There are only two access types on {{SITENAME}}. Most protections will use the normal access type, while doors, trapdoors, and gates can optionally be assigned the autoclose access type.		There are only two access types on {{SITENAME}}. Most protections will use the normal access type, while doors, trapdoors, and gates can optionally be assigned the autoclose access type.
	{{Component/section\|		{{Component/section\|
Line 75:		Line 75:
	}}		}}

	===Source types===		=== Source types ===
	Source types determine who is allowed to access a protected container. For example, if the source type is set to "Player", then the specified players will be allowed to open the container.		Source types determine who is allowed to access a protected container. For example, if the source type is set to "Player", then the specified players will be allowed to open the container.
	{{Component/section\|		{{Component/section\|
Line 90:		Line 90:
	\|port = {{Item\|command_block}}		\|port = {{Item\|command_block}}
	\|title = '''Permission'''		\|title = '''Permission'''
	\|subtitle = All players who possess a particular {{#inline-tooltip:permission\|"Permissions" are short strings applied to users and ranks that are used to determine access to server features.}} have automatic access to the protection, even if they were not explicitly trusted. This protection type is similar to password, but all players who are a part of a specified [[Rank]] or [[Plugins:Levels\|Level]] will have access to the protection. Other permissions can be specified if they are known to the user creating the protection. Please note that players are not able to modify the permission nodes of other users.}}{{Component		\|subtitle = All players who possess a particular {{#inline-tooltip:permission\|"Permissions" are short strings applied to users and ranks that are used to determine access to server features.}} have automatic access to the protection, even if they were not explicitly trusted. This protection type is similar to password, but all players who are a part of a specified [[Rank]] or [[Plugins:Levels\|Level]] will have access to the protection. Other permissions can be specified if they are known to the user creating the protection. Please note that players are not able to modify the permission nodes of other users.
			{{Spoiler box
			\|header = ''View all public permissions''
			\|content =<nowiki></nowiki>
			* {{Copy\|prism.rank.all}} - ''Targets all players. Effectively the same as making a protection public''
			* {{Copy\|prism.rank.generic.player}} - ''Targets all players except staff. This is effectively the same as the previous permission since staff have access to all protections anyway''
			* {{Copy\|prism.rank.generic.staff}} - ''Targets only staff members''
			* {{Copy\|prism.rank.generic.donor}} - ''Targets all players who have a donor rank''
			* {{Copy\|prism.rank.pebble}} - ''Targets only players with the pebble rank''
			* {{Copy\|prism.rank.<rank>}} - ''Targets only players with the specified rank. The rank name must be in lowercase''
			* {{Copy\|group.1}} - ''Targets only players who are at least /level 1''
			}}
			}}{{Component
	\|port = {{Item\|bundle}}		\|port = {{Item\|bundle}}
	\|title = '''Group'''		\|title = '''Group'''
Line 98:		Line 110:
	}}		}}

	==Commands==		== Commands ==
	{{Hatnote\|{{Icon\|notice}}<nowiki>[Square brackets]</nowiki> indicate optional parameters, while <nowiki><angle brackets></nowiki> indicate required parameters.}}		{{Hatnote\|{{Icon\|notice}}<nowiki>[Square brackets]</nowiki> indicate optional parameters, while <nowiki><angle brackets></nowiki> indicate required parameters.}}

Line 191:		Line 203:
	\| body = <nowiki></nowiki>		\| body = <nowiki></nowiki>
	# Run {{CMD\|bolt modify add normal permission group.1}}. Any players who inherit the specified group/permission have automatic access to the container.		# Run {{CMD\|bolt modify add normal permission group.1}}. Any players who inherit the specified group/permission have automatic access to the container.
	~~''You can view a list of public permission nodes on this page.''~~
	}}		}}
	{{Rules		{{Rules

BakiDance at 19:49, 10 July 2024

2024-07-10T19:49:23Z

← Older revision		Revision as of 19:49, 10 July 2024
Line 162:		Line 162:
	}}		}}
	{{Component		{{Component
	\|port = {{Item\|~~barrier~~}}		\|port = {{Item\|honeycomb}}
	\|title = '''persist'''		\|title = '''persist'''
	\|subtitle = Toggle whether modifications from {{CMD\|bolt modify}} and {{CMD\|bolt edit}} should apply only to a single clicked container, or apply to every container that is clicked with until disabled. This setting prevents you from needing to type the same command multiple times to modify an array of containers.		\|subtitle = Toggle whether modifications from {{CMD\|bolt modify}} and {{CMD\|bolt edit}} should apply only to a single clicked container, or apply to every container that is clicked with until disabled. This setting prevents you from needing to type the same command multiple times to modify an array of containers.

BakiDance: Created page with "{{Infobox plugin | image = Bolt.png | name = Bolt | type = Protection | server = {{SITENAME}} | rootcommand = bolt | subcommands = 10 | custom = No |level = 1 | extwiki = https://github.com/pop4959/Bolt/wiki }} {{Hatnote|{{Icon|notice}} Players are required to be at least Level 1 in order to access these features.}} '''Bolt''' is a single-block and e..."

2024-07-10T19:48:12Z

Created page with "{{Infobox plugin | image = Bolt.png | name = Bolt | type = Protection | server = {{SITENAME}} | rootcommand = bolt | subcommands = 10 | custom = No |level = 1 | extwiki = https://github.com/pop4959/Bolt/wiki }} {{Hatnote|{{Icon|notice}} Players are required to be at least Level 1 in order to access these features.}} '''Bolt''' is a single-block and e..."

New page

{{Infobox plugin
| image = Bolt.png
| name = Bolt
| type = Protection
| server = {{SITENAME}}
| rootcommand = bolt
| subcommands = 10
| custom = No
|level = 1
| extwiki = https://github.com/pop4959/Bolt/wiki
}}
{{Hatnote|{{Icon|notice}} Players are required to be at least [[Plugin:Levels|Level]] 1 in order to access these features.}}

'''Bolt''' is a single-block and entity protection plugin used on some servers within the {{SITENAME}} Network. Bolt automatically protects [[Plugin:Bolt/Default Protections|most blocks]] placed by players with [[prism:Levels|level 1]]. Similar to how [[Plugin:GriefDefender|GriefDefender]] allows players to create and manage land claims, Bolt enables players to manage their individual block protections to modify behaviors, trust other users, and manage access.

When blocks protected with Bolt are located on GriefDefender claims, the land claim protection settings always take priority. Players and staff should be mindful of which system is managing access for a given block, and adjust the protection(s) accordingly. As is the case with land claims, Bolt protections expire after 120 days of inactivity[''See notes''].

Bolt is a core plugin on {{SITENAME}}. Generally speaking, this means that the network can't update unless this plugin is also updated and working. Bugs impacting this plugin are considered severe.

==Features==
*Protects both blocks and entities
*Allows locking of almost any block
*Set different protection modes
*Trust users or groups on existing blocks
*Set blocks to require password for access

==Configuring protections==
===Protection types===
Protections types determine how other players should be allowed to interact with a locked container.
{{Component/section|
{{Component/group|
{{Component
|port = {{Item|chest}}
|title = '''Private'''
|subtitle = The default mode for most blocks. Only the owner and trusted members can interact with the block.
}}
{{Component
|port = {{Item|lectern}}
|title = '''Display'''
|subtitle = The default mode for signs and lecterns. Only the owner and trusted members can interact, but all players can view contents.
}}
{{Component
|port = {{Item|composter}}
|title = '''Deposit'''
|subtitle = The default mode for composters. All players can add items, but only the owner and trusted members can take items and interact.
}}
}}{{Component/group|
{{Component
|port = {{Item|hopper}}
|title = '''Withdrawal'''
|subtitle = All players can remove items, but only the owner and trusted members can add items and interact. Useful for farm outputs.
}}
{{Component
|port = {{Item|ender_chest}}
|title = '''Public'''
|subtitle = The default mode for enderchests. All players can interact, but only the owner and trusted members can break the block.
}}
}}
}}

===Access types===
There are only two access types on {{SITENAME}}. Most protections will use the normal access type, while doors, trapdoors, and gates can optionally be assigned the autoclose access type.
{{Component/section|
{{Component/group|
{{Component
|port = {{Item|chest}}
|title = '''Normal'''
|subtitle = The default access type for all protections.
}}{{Component
|port = {{Item|oak_door}}
|title = '''Autoclose'''
|subtitle = Useful only for doors, trapdoors, and gates. Otherwise identical to the "normal" access type, this access type automatically closes doors and gates that have been opened by a player after 3 seconds. Useful for public builds where you want to enforce that a door or gate remains closed after use.
}}
}}
}}

===Source types===
Source types determine who is allowed to access a protected container. For example, if the source type is set to "Player", then the specified players will be allowed to open the container.
{{Component/section|
{{Component/group|
{{Component
|port = {{Item|totem_of_undying}}
|title = '''Player'''
|subtitle = The default source type for all protections. Only players who have been trusted via {{CMD|bolt edit}} can access the protection.
}}{{Component
|port = {{Item|name_tag}}
|title = '''Password'''
|subtitle = All players who know the password have access to the protection, even if they were not explicitly trusted. The password can be given to a protection via {{CMD|bolt password <password>}}, thus unlocking it for that user if the input is correct.
}}{{Component
|port = {{Item|command_block}}
|title = '''Permission'''
|subtitle = All players who possess a particular {{#inline-tooltip:permission|"Permissions" are short strings applied to users and ranks that are used to determine access to server features.}} have automatic access to the protection, even if they were not explicitly trusted. This protection type is similar to password, but all players who are a part of a specified [[Rank]] or [[Plugins:Levels|Level]] will have access to the protection. Other permissions can be specified if they are known to the user creating the protection. Please note that players are not able to modify the permission nodes of other users.}}{{Component
|port = {{Item|bundle}}
|title = '''Group'''
|subtitle = All players who are part of a group created via the {{CMD|bolt group}} command have access to this chest. This is similar to the default "player" source type, except all players who are part of the specified group gain access automatically and ''do not'' need to be added to the individual protection manually via {{CMD|bolt edit}}. This source type is useful when you have multiple protections that you wish to provide multiple players with access to, as it removes the need to type multiple commands per container.
}}
}}
}}

==Commands==
{{Hatnote|{{Icon|notice}}<nowiki>[Square brackets]</nowiki> indicate optional parameters, while <nowiki><angle brackets></nowiki> indicate required parameters.}}

{{Navplate
|title = Lock
|label1 = {{#inline-tooltip: /bolt lock [mode]| /lock [mode]}}
|list1 = Lock something, preventing access to untrusted players. Optionally provide a protection mode to lock with. If a mode isn't specified, defaults to Private.
}}
{{Navplate
|title = Unlock
|label1 = {{#inline-tooltip: /bolt unlock| /unlock}}
|list1 = Unlock something, removing all protections.
}}
{{Navplate
|title = Edit
|label1 = <nowiki>/bolt edit <add|remove> <player></nowiki>
|list1 = Edit a protection to add or remove another player's access.
}}
{{Navplate
|title = Modify
|label1 = <nowiki>/bolt modify <add|remove> <access type> <source type> <sources></nowiki>
|list1 = Add or remove sources with given access to a protection's access list.
|label2 = Access types
|list2 = The access type dictates how the protection should interact with trusted players.
|label3 = Sources
|list3 = The actual sources to use, based on the specified source type. For example, if the source type is "player", then this parameter should be the username of a player.
}}
{{Navplate
|title = Group
|label1 = <nowiki>/bolt group <create|delete|add|remove|list> <group name/usernames> [player names]</nowiki>
|list1 = Create and manage custom player groups which can then be applied to protections using the group sources type. When specifying multiple usernames to add or remove from a group, separate the usernames with a space.
}}
{{Navplate
|title = Trust
|label1 = <nowiki>/bolt trust <add|remove> <source type> <sources> [access type]</nowiki>
|list1 = View or modify your global trust list. Players with access to the specified source type will be able to access all of your protected containers globally. This setting applies immediately across all protections, thus removing the need to manually modify all protections if you wish to allow access across a large array of protections. Run {{CMD|bolt trust}} to view your trust list.
}}
{{Navplate
|title = Transfer
|label1 = <nowiki>/bolt transfer <player name></nowiki>
|list1 = Transfer ownership of a single protection to another user. The original settings of that protection are retained, meaning that unless you added yourself to the container using {{CMD|bolt edit}} you will no longer be able to open it once transferred.
}}
{{Navplate
|title = Password
|label1 = <nowiki>/bolt password <password></nowiki>
|list1 = Enter a password for a protection that has a password source added. This command is not used to create password-protected containers, but is instead used to ''open'' a password-protected container owned by another player. To create a password-protected container, use {{CMD|bolt modify add normal password <password>}} instead.
}}
{{Navplate
|title = Mode
|label1 = <nowiki>/bolt mode <mode></nowiki>
|list1 = Toggle on or off a player mode. Player mode toggles modify how the Bolt plugin interacts with your actions.
|label2 = Player modes
|list2 =
{{Component
|port = {{Item|tripwire_hook}}
|title = '''nolock'''
|subtitle = Toggle whether or not containers should be automatically protected when placed.
}}
{{Component
|port = {{Item|barrier}}
|title = '''nospam'''
|subtitle = Toggle whether or not protection alerts should be shown in the actionbar.
}}
{{Component
|port = {{Item|barrier}}
|title = '''persist'''
|subtitle = Toggle whether modifications from {{CMD|bolt modify}} and {{CMD|bolt edit}} should apply only to a single clicked container, or apply to every container that is clicked with until disabled. This setting prevents you from needing to type the same command multiple times to modify an array of containers.
}}
}}
{{Navplate
|title = Info
|label1 = <nowiki>/bolt info</nowiki>
|list1 = View information about a protection, such as the protection type and access list.
}}

==Examples==
{{Rules
| title = Trust multiple people on some containers
| body = <nowiki></nowiki>
# First create a group using {{CMD|bolt group create <group name>}}. The name of your group cannot already be in use by another player.
# Once the group is created, add users to it with {{CMD|bolt group add <usernames>}}. You can add multiple names at once, separated by a space.
# Run {{CMD|bolt modify add normal group <group name>}} and click the block to apply the change. Now, all users within the created group will have access to the container. Users can be added or removed from the group at any time.
}}
{{Rules
| title = Trust someone across all of your containers
| body = <nowiki></nowiki>
# Run {{CMD|bolt trust add player <username>}}. Any players you trust will have access to all your protections globally.
''You can view users or sources you have trusted with {{CMD|bolt trust}}.''
}}
{{Rules
| title = Trust everyone who is at least /Level 1 on a container
| body = <nowiki></nowiki>
# Run {{CMD|bolt modify add normal permission group.1}}. Any players who inherit the specified group/permission have automatic access to the container.
''You can view a list of public permission nodes on this page.''
}}
{{Rules
| title = Create a password-protected container
| body = <nowiki></nowiki>
# On the container you would like to lock with a password, run {{cmd|/bolt modify add normal password <password>}}.
# Click the block to apply the change. From here on, all players who know the password can open the container by first running {{CMD|bolt password <password>}} until they log out.
}}
{{Rules
| title = Make a door automatically close after opening
| body = <nowiki></nowiki>
# Doors, gates, and trapdoors can be set to automatically close after 3 seconds. Autoclose must be manually activated per user in most cases but since most doors are automatically protected, this is often redundant.
# Set it so that all users are able to access autoclose for the door by running {{CMD|bolt modify add autoclose permission prism.rank.all}}. Even though all users have access to auto-close on the door, only those who have been given access to open the door will be able to actually use it.
# You can now optionally add other users to access the door via {{CMD|bolt edit add <name>}} or change the protection type (such as making it public) with {{CMD|bolt lock <type>}}.
}}

== Notes ==
* Group names must be unique. If a group named "Friends" already exists for another user, you will not be able to name your group that.
* Block protections are set to expire 120 days after the protected block was last ''interacted'' with. This differs from the expiry behavior of [[Plugin:GriefDefender|land claims]], which only expire after 120 days of player ''inactivity''.
** This means that active players may still lose protections on blocks they have not interacted with for prolonged periods of time.
* Redstone features are automatically enabled for all protected blocks, unnecessitating the use of commands like {{CMD|chopper on}}.
* [[Plugin:GriefDefender|Land claims]] permissions override chest access. In order to give a player access to a container within a claim, that player must be trusted in both the claim and on the container.