designdoc.txt

=== ProTips Design Doc ===


TipGroup Class
String group;
int interval;
int next;
HashMap<String, String> tips;
String color;
String world;

/protip
/protips

=== Protips Help ===
Parameters in &i<angle brackets>&m are required; parameters in &i[square brackets]&m are optional.
Most commands have a shorthand form: "&i-h|elp&m" indicates that you could use &i-h&m or &ihelp
/protip &i-o|n/ff&m - &i-o&m toggles receiving tips; can optionally specify &ion&m or &ioff
/protip &i-h|elp [category]&m - Specify a category to see its commands: &itip&m, &igroup&m, &ilist&m, &iadmin

=== Protips Tip Commands ===
/protip &i-t|ip new <label> <tip>&m - Add a new tip with &i<label>
/protip &i-t|ip del|ete <label>&m - Delete the tip with &i<label>
/protip &i-t|ip mod|ify <label> <tip>&m - Change the tip with &i<label>&m to &i<tip>
/protip &i-t|ip show <label>&m - Show the tip with &i<label>

=== Protips List Commands ===
/protip &i-l|ist tips&m - List all tip labels
/protip &i-l|ist groups [group]&m - List all groups, or list tip labels belonging to &i[group]&m if specified

=== Protips Group Commands ===
/protip &i-g|roup new <group> [interval] [color] [world]&m - Create a new &i<group>&m; leaving options blank uses the defaults
/protip &i-g|roup del|ete <group>&m - Delete &i<group>
/protip &i-g|roup mod|ify <flag> <newvalue>&m - Changes group flags, acceptable flags are &iname&m, &iinterval&m, &icolor&m, or &iworld
/protip &i-g|roup add <group> <labels>...&m - Add a list of &i<labels>&m to &i<group>
/protip &i-g|roup rem|ove <group> <labels>...&m - Remove a list of &i<labels>&m from &i<group>

=== Protips Admin Commands ===
/protip &i-f|lush&m - Save all in-game memory to config.yml (overwrites changes made to file)
/protip &i-r|eload&m - Load everything from config.yml into memory (overwrites unsaved changes made in memory)
/protip &i-s|end <name> <label>&m - Send the tip with &i<label>&m to &i<name>

players:
    showtips:
messages:
    tips:
	    <label>: '&7This is a tip that can be defined.'
		<label2>: '&cThis is another tip.'
    global:
		name:
	    override:
	    interval:
		color: AQUA
		world: world
		tips: [tutorial, motd]
	groups:
	    <group>:
		    interval:
			color: null
			tips: [label, label2, tutorial, motd]
			world: world
		Citizen:
		Moderator:
		Admin: