Configuration - Revision history

Fullwall at 16:28, 15 December 2022

2022-12-15T16:28:51Z

← Older revision		Revision as of 16:28, 15 December 2022
Line 63:		Line 63:
	realistic-looking: false # whether to check line of sight when looking close		realistic-looking: false # whether to check line of sight when looking close
	stationary-ticks: -1 # how many ticks can an NPC be stuck in the same block before teleporting to the goal / performing the 'stuck action'		stationary-ticks: -1 # how many ticks can an NPC be stuck in the same block before teleporting to the goal / performing the 'stuck action'
			block-breaker-radius: -1 # the default radius in blocks for the NPC to pathfind to when breaking blocks
	talk-close:		talk-close:
	enabled: false		enabled: false
Line 89:		Line 90:
	use-latest-by-default: false # whether to always fetch new skin updates		use-latest-by-default: false # whether to always fetch new skin updates
	view-distance: 100.0		view-distance: 100.0
			placeholder-update-frequency-ticks: 6000 # how often to update skin placeholders, in ticks
	packets:		packets:
	update-delay: 30 # performance option, lower = faster updates to equipment, higher = slower updates but more performance		update-delay: 30 # performance option, lower = faster updates to equipment, higher = slower updates but more performance
Line 105:		Line 107:
	player-scoreboard-teams:		player-scoreboard-teams:
	enable: true		enable: true
			follow:
			teleport-across-worlds: true # whether to teleport cross-world when /npc follow is enabled
			commands:
			global-delay-seconds: 1 # the global delay between click commands in seconds. set to 0 for no delay between commands
			error-messages:
			maximum-times-used: You have reached the maximum number of uses ({0}).
			missing-item: Missing {1} {0}
			no-permission: You don't have permission to do that.
			not-enough-experience: You need at least {0} experience.
			not-enough-money: You need at least ${0}.
			on-cooldown: Please wait for {minutes} minutes and {seconds_over} seconds.
			on-global-cooldown: Please wait for {minutes} minutes and {seconds_over} seconds.
	advanced:		advanced:
	check-minecraft-version: true		check-minecraft-version: true

Fullwall at 16:26, 15 December 2022

2022-12-15T16:26:34Z

← Older revision		Revision as of 16:26, 15 December 2022
Line 8:		Line 8:
	authlib:		authlib:
	profile-url: https://sessionserver.mojang.com/session/minecraft/profile/ # generally shouldn't be touched, but allows you to configure a custom GameProfile server for advanced users		profile-url: https://sessionserver.mojang.com/session/minecraft/profile/ # generally shouldn't be touched, but allows you to configure a custom GameProfile server for advanced users
			debug-chunk-loads: false # for advanced debugging of when chunks are loaded and why
	debug-file: '' # whether to log debug output to a file instead of to console		debug-file: '' # whether to log debug output to a file instead of to console
	debug-mode: false # enables debugging mode with extra information on spawning, skin fetching, etc.		debug-mode: false # enables debugging mode with extra information on spawning, skin fetching, etc.
	debug-pathfinding: false # enables pathfinding debugging which shows a visual display (yellow flowers) of where NPCs are pathfinding to		debug-pathfinding: false # enables pathfinding debugging which shows a visual display (yellow flowers) of where NPCs are pathfinding to
	color-scheme:		color-scheme:
	message-error: <c> # the error message colour, default red		message-error: <red> # the error message colour, default red
	message-highlight: <e> # the highlight colour, default yellow		message-highlight: <yelloe> # the highlight colour, default yellow
	message: <a> # the default message colour, default green		message: <green> # the default message colour, default green
	translation:		translation:
	locale: '' # if you want to use a specific language translation such as fr_FR etc.		locale: '' # if you want to use a specific language translation such as fr_FR etc.
			reload-warning-enabled: true # whether to require /citizens reload entered twice
	npc:		npc:
			always-use-name-holograms: false # whether to always use name holograms (armor stands) for nameplates rather than custom names
	chat:		chat:
	options:		options:
Line 25:		Line 28:
	range: 5		range: 5
	max-text-range: 500		max-text-range: 500
			talk-to-npcs: true # whether to include NPCs in chat
	format:		format:
	no-targets: '[<npc>]: <text>'		no-targets: '[<npc>]: <text>'
Line 31:		Line 35:
	with-targets-to-bystanders: '[<npc>] -> [<targets>]: <text>'		with-targets-to-bystanders: '[<npc>] -> [<targets>]: <text>'
	pathfinding:		pathfinding:
			new-finder:
			iterations-per-tick: 5000 # how many steps to run of the new pathfinder every tick. Useful when you want to spread pathfinding over multiple ticks
			check-bounding-boxes: false # whether to check bounding boxes of entities can fit e.g. through single block gaps or fences etc
			open-doors: false # whether to open/close doors while pathfinding
			defaults:
			destination-teleport-margin: -1 # teleport to the destination when below this threshold. e.g. you may want to teleport to the exact destination if <2 blocks away
	default-distance-margin: 2 # the distance from the goal to stop early while moving along a path measured in blocks squared		default-distance-margin: 2 # the distance from the goal to stop early while moving along a path measured in blocks squared
	default-path-distance-margin: 1 # the distance from the goal to stop early while finding a path measured in blocks		default-path-distance-margin: 1 # the distance from the goal to stop early while finding a path measured in blocks
	update-path-rate: 20 # how often to update the path in ticks, typically for entity targeting		update-path-rate: 20 # how often to update the path in ticks, typically for entity targeting
	maximum-new-pathfinder-iterations: ~~50000~~ # the maximum number of blocks to search while pathfinding using the new pathfinder		maximum-new-pathfinder-iterations: 10000 # the maximum number of blocks to search while pathfinding using the new pathfinder
	~~new~~-~~finder~~-~~open-doors~~: ~~false~~ # ~~whether~~ the ~~NPC should open doors~~ while ~~moving~~ (~~new finder only~~)		minecraft:
			max-fall-distance: 3 # the maximum fall distance to check while pathfinding (old pathfinder)
	attack-range: 3.0625		attack-range: 3.0625
	use-new-finder: false # whether to use the built in Citizens A* pathfinder instead of Minecraft's		use-new-finder: false # whether to use the built in Citizens A* pathfinder instead of Minecraft's
	disable-mc-fallback-navigation: true		disable-mc-fallback-navigation: true # minecraft by default will try to use 'fallback' pathfinding where it returns the closest reachable block to the destination. by default try to reach the destination only.
	default:		default:
			bossbar-view-range: 64 # the bossbar view range, blocks
	look-close:		look-close:
	enabled: false		enabled: false
	range: 5		range: 5 # range in blocks
	random-look-enabled: false		random-look-enabled: false
	random-look-delay: 60		random-look-delay: 60 # delay in ticks
	disable-while-navigating: true		disable-while-navigating: true
	pathfinding:		pathfinding:
	range: 25.0 # the maximum pathfinding ~~goal~~ range in blocks		range: 75.0 # the maximum pathfinding range to destination in blocks
	random-talker: true		random-talker: true
	realistic-looking: false # whether to check line of sight when looking close		realistic-looking: false # whether to check line of sight when looking close
Line 56:		Line 68:
	text: # default text		text: # default text
	'0': Hi, I'm <npc>!		'0': Hi, I'm <npc>!
			waypoints:
			cache-paths: false # whether to cache paths found for /npc path. eliminates pathfinding when used
	limits:		limits:
	default-limit: 10		default-limit: 10

Fullwall at 03:17, 1 May 2020

2020-05-01T03:17:53Z

Show changes

Fullwall at 05:55, 18 November 2014

2014-11-18T05:55:36Z

← Older revision		Revision as of 05:55, 18 November 2014
Line 90:		Line 90:
	{{H:title\|Item you have to right-click the NPC with for them to talk\|talk-item: 340}}		{{H:title\|Item you have to right-click the NPC with for them to talk\|talk-item: 340}}
	{{H:title\|Whether the server owns an NPC by default\|server-ownership: false}}		{{H:title\|Whether the server owns an NPC by default\|server-ownership: false}}
	<nowiki></nowiki>~~{{H:title\|The name of the database\|database:}}~~		<nowiki></nowiki>
	~~{{H:title\|The password for the database connection.\|password: ''}}~~
	~~{{H:title\|The username for the database connection.\|username: ''}}~~
	~~{{H:title\|The URL for connecting to the database.\|url: ''}}~~
	~~{{H:title\|The driver to use when connecting to the database. Eg. MySQL, SQLite, H2\|driver: ''}}~~
	<nowiki></nowiki>{{H:title\|General settings regarding Citizens\|general:}}		<nowiki></nowiki>{{H:title\|General settings regarding Citizens\|general:}}
	{{H:title\|Whether to be in debug mode or not. Prints more messages to console about Citizens.\|debug-mode: false}}		{{H:title\|Whether to be in debug mode or not. Prints more messages to console about Citizens.\|debug-mode: false}}
	~~<nowiki></nowiki>{{H:title\|Whether to use databases or not.\|use-database: false}}~~
	<nowiki></nowiki>{{H:title\|Subplugin settings\|subplugins:}}		<nowiki></nowiki>{{H:title\|Subplugin settings\|subplugins:}}
	{{H:title\|The folder to load subplugins from\|folder: 'plugins'}}		{{H:title\|The folder to load subplugins from\|folder: 'plugins'}}

Fullwall at 05:55, 18 November 2014

2014-11-18T05:55:13Z

← Older revision		Revision as of 05:55, 18 November 2014
Line 52:		Line 52:
	checkminecraftversion: true # set this to false to disable minecraft compatibility checks. Should not normally be used.		checkminecraftversion: true # set this to false to disable minecraft compatibility checks. Should not normally be used.
	storage:		storage:
	~~database:~~
	~~driver: '' # should be sqlite/mysql/h2, depending on the database~~
	~~password: '' # the database password if needed~~
	~~url: '' # the database URL: eg. sqlite://path/to/my.db~~
	~~username: '' # the database username if needed~~
	savetask:		savetask:
	delay: 72000 # the delay in ticks before everything gets serialised to disk		delay: 72000 # the delay in ticks before everything gets serialised to disk
	file: saves.yml # the storage file		file: saves.yml # the storage file
	type: yaml # the type: can be NBT~~, database~~, YAML.		type: yaml # the type: can be NBT, YAML.
	general:		general:
	debugmode: false # enable debug output		debugmode: false # enable debug output

Fullwall: /* Default Configuration */

2013-03-07T13:54:34Z

Default Configuration

← Older revision		Revision as of 13:54, 7 March 2013
Line 4:		Line 4:
	<pre>		<pre>
	# Citizens Configuration		# Citizens Configuration

	npc:		npc:
	chat:		chat:
	~~prefix~~: '[<npc>]: '		options:
			bystandersheartargetedchat: true
			maxnumberoftargetstoshow: 2
			multipletargetsformat: <target>\|, <target>\| & <target>\| & others
			range: 5
			format:
			notargets: '[<npc>]: <text>'
			withtargettobystanders: '[<npc>] -> [<target>]: <text>'
			totarget: '[<npc>] -> You: <text>'
			withtargetstobystanders: '[<npc>] -> [<targets>]: <text>'
	default:		default:
	~~look-close~~:		lookclose: # NPCs turning heads towards players settings
	enabled: false		enabled: false # whether look close is enabled by default
	range: 5		range: 5 # the look close range
	pathfinding:		pathfinding:
	range: 25.0		range: 25.0 # the maximum pathfinding range to search through before giving up
	~~random-talker~~: true		randomtalker: true # whether the NPC will randomly select a text item instead of sequentially
	~~realistic-looking~~: false		realisticlooking: false # whether the NPC will ensure potential players to look at / talk to aren't obscured by walls
	~~stationary-ticks~~: -1		stationaryticks: -1 # how long the NPC will be stationary while pathfinding before giving up
	~~talk-close~~:		talkclose:
	enabled: false		enabled: false # default talk close
	range: 5		range: 5 # range before NPC talks
	text:		text:
	'0': Hi, I'm <npc>!		'0': Hi, I'm <npc>! # default text
	limits:		limits:
	default-limit: 10		defaultlimit: 10 # the default per-player NPC limit
	~~max-permission-checks~~: 100		maxpermissionchecks: 100 # the maximum number of per-player NPCs a player can have
			maxspeed: 100 # the maximum speed an NPC can have
			chunks:
			alwayskeeploaded: false # whether to always keep chunks loaded with NPCs in them or unload them when there are no other players inside the chunk
	selection:		selection:
	~~quick-select~~: false		quickselect: false # no message will be sent
	item: '280'		item: '280' # the selector item: default is stick
	message: <b>You selected <a><npc><b>!		message: <b>You selected <a><npc><b>! # the message sent on select
	~~server~~-~~ownership~~: false		player:
			removefromlist: true # setting this to false will enable human NPCs to be recognised by mobs; it will also make them just like a normal player, which means other plugins will recognise them as well. This can be enabled per-NPC using /npc playerlist
			serverownership: false # whether the server owns NPCs by default
	text:		text:
	~~max-~~talk-cooldown~~: 60~~		maxtalkcooldown: 1 # the maximum cooldown before the NPC will talk close in seconds : the cooldown is chosen at random between the min/max
	~~min-~~talk~~-cooldown: 30~~		mintalkcooldown: 1 # the minimum cooldown before the NPC will talk close in seconds
	~~talk-item~~: '340'		talkitem: '340' # the items that will cause the NPC to talk to you on right click : default is book
	~~player~~:		pathfinding:
	~~remove~~-~~from-list~~: true		usenewfinder: false # EXPERIMENTAL: enable non-Minecraft pathfinder
			advanced:
			checkminecraftversion: true # set this to false to disable minecraft compatibility checks. Should not normally be used.
	storage:		storage:
	database:		database:
	driver: ''		driver: '' # should be sqlite/mysql/h2, depending on the database
	password: ''		password: '' # the database password if needed
	url: ''		url: '' # the database URL: eg. sqlite://path/to/my.db
	username: ''		username: '' # the database username if needed
	~~save-task~~:		savetask:
	delay: 72000		delay: 72000 # the delay in ticks before everything gets serialised to disk
	file: saves.yml		file: saves.yml # the storage file
	type: yaml		type: yaml # the type: can be NBT, database, YAML.
	general:		general:
	debug~~-mode~~: ~~false~~		debugmode: false # enable debug output
			colorscheme:
			messagehighlight: <e> # set the default highlight colour: usually yellow.
			message: <a> # set the default message colour: usually green.
			translation:
			locale: '' # set the locale explicitly if needed: eg. en_US is US English, de_DE is the generic German locale
	economy:		economy:
	npc:		npc:
	cost: 100.0		cost: 100.0 # the cost of an NPC. NOTE: requires Vault
	subplugins:		subplugins:
	folder: plugins		folder: plugins # subplugins like Denizen etc can be placed into Citizens/<subplugins folder> for organisational purposes.
	</pre>		</pre>

Jrbudda: /* Default Configuration */

2012-09-19T21:19:18Z

Default Configuration

← Older revision		Revision as of 21:19, 19 September 2012
Line 34:		Line 34:
	min-talk-cooldown: 30		min-talk-cooldown: 30
	talk-item: '340'		talk-item: '340'
			player:
			remove-from-list: true
	storage:		storage:
	database:		database:

Jrbudda: /* Default Configuration */

2012-09-03T20:49:47Z

Default Configuration

← Older revision		Revision as of 20:49, 3 September 2012
Line 10:		Line 10:
	default:		default:
	look-close:		look-close:
			enabled: false
	range: 5		range: 5
	~~enabled~~: ~~false~~		pathfinding:
			range: 25.0
	random-talker: true		random-talker: true
			realistic-looking: false
			stationary-ticks: -1
	talk-close:		talk-close:
			enabled: false
	range: 5		range: 5
	~~enabled: false~~
	text:		text:
	'0': Hi, I'm <npc>!		'0': Hi, I'm <npc>!
	~~realistic-looking~~: ~~false~~		limits:
	~~look-close~~-~~range~~: 5		default-limit: 10
	~~talk~~-~~close~~-~~range~~: 5		max-permission-checks: 100
	~~pathfinding:~~
	~~range: 25.0~~
	~~stationary-ticks: -1~~
	selection:		selection:
	quick-select: false		quick-select: false
Line 33:		Line 34:
	min-talk-cooldown: 30		min-talk-cooldown: 30
	talk-item: '340'		talk-item: '340'
	~~pathing:~~
	~~default-pathfinding-range: 25.0~~
	~~limits:~~
	~~default-limit: 10~~
	~~max-permission-checks: 100~~
	storage:		storage:
	database:		database:
Line 44:		Line 40:
	url: ''		url: ''
	username: ''		username: ''
			save-task:
			delay: 72000
	file: saves.yml		file: saves.yml
	type: yaml		type: yaml
	~~save-task:~~
	~~delay: 72000~~
	general:		general:
	debug-mode: false		debug-mode: false
	~~subplugins:~~
	~~folder: plugins~~
	economy:		economy:
	npc:		npc:
	cost: 100.0		cost: 100.0
			subplugins:
			folder: plugins
	</pre>		</pre>

Jrbudda at 20:33, 3 September 2012

2012-09-03T20:33:35Z

← Older revision		Revision as of 20:33, 3 September 2012
Line 58:		Line 58:


	{{hidden~~\|collapsed~~\|old config\|		{{hidden\|old config\|
	Mouse over each field to see what each one is used for.		Mouse over each field to see what each one is used for.
	<nowiki></nowiki># Citizens Configuration		<nowiki></nowiki># Citizens Configuration

Jrbudda at 20:32, 3 September 2012

2012-09-03T20:32:04Z

← Older revision		Revision as of 20:32, 3 September 2012
Line 58:		Line 58:


	{{hidden\|old config\|		{{hidden\|collapsed\|old config\|
	Mouse over each field to see what each one is used for.		Mouse over each field to see what each one is used for.
	<nowiki></nowiki># Citizens Configuration		<nowiki></nowiki># Citizens Configuration

← Older revision		Revision as of 05:55, 18 November 2014
Line 90:		Line 90:
	{{H:title\|Item you have to right-click the NPC with for them to talk\|talk-item: 340}}		{{H:title\|Item you have to right-click the NPC with for them to talk\|talk-item: 340}}
	{{H:title\|Whether the server owns an NPC by default\|server-ownership: false}}		{{H:title\|Whether the server owns an NPC by default\|server-ownership: false}}
	<nowiki></nowiki>~~{{H:title\|The name of the database\|database:}}~~		<nowiki></nowiki>
	~~{{H:title\|The password for the database connection.\|password: ''}}~~
	~~{{H:title\|The username for the database connection.\|username: ''}}~~
	~~{{H:title\|The URL for connecting to the database.\|url: ''}}~~
	~~{{H:title\|The driver to use when connecting to the database. Eg. MySQL, SQLite, H2\|driver: ''}}~~
	<nowiki></nowiki>{{H:title\|General settings regarding Citizens\|general:}}		<nowiki></nowiki>{{H:title\|General settings regarding Citizens\|general:}}
	{{H:title\|Whether to be in debug mode or not. Prints more messages to console about Citizens.\|debug-mode: false}}		{{H:title\|Whether to be in debug mode or not. Prints more messages to console about Citizens.\|debug-mode: false}}
	~~<nowiki></nowiki>{{H:title\|Whether to use databases or not.\|use-database: false}}~~
	<nowiki></nowiki>{{H:title\|Subplugin settings\|subplugins:}}		<nowiki></nowiki>{{H:title\|Subplugin settings\|subplugins:}}
	{{H:title\|The folder to load subplugins from\|folder: 'plugins'}}		{{H:title\|The folder to load subplugins from\|folder: 'plugins'}}