v3.2.0

Final help panel tweaks
Allow typing expiration blocks as multiline

Author: JannisX11

dist/app.js

@@ -1,6 +1,6 @@
 {
 	"name": "snowstorm",
-	"version": "3.1.0",
+	"version": "3.2.0",
 	"description": "Minecraft Bedrock Edition particle editor",
 	"author": {
 		"name": "JannisX11",
@@ -32,20 +32,20 @@
 		"vue-template-compiler": "^2.6.12",
 		"webpack": "^5.89.0",
 		"webpack-bundle-size-analyzer": "^3.1.0",
-		"webpack-cli": "^3.3.12",
+		"webpack-cli": "^5.1.4",
 		"webpack-dev-server": "^5.0.2"
 	},
 	"dependencies": {
 		"bootstrap": "^4.6.2",
 		"fflate": "^0.7.3",
 		"lucide-vue": "^0.298.0",
-		"molangjs": "^1.6.4",
+		"molangjs": "^1.6.5",
 		"prismjs": "^1.28.0",
 		"root": "github:JannisX11/vue-prism-editor",
 		"three": "^0.134.0",
 		"vue": "^2.6.12",
 		"vue-color": "^2.8.0",
 		"vue-prism-component": "^1.2.0",
-		"wintersky": "^1.3.0"
+		"wintersky": "^1.3.2"
 	}
 }

package-lock.json

@@ -22,7 +22,7 @@
 		<code-viewer v-if="tab == 'code'"></code-viewer>
 
 
-		<help-panel v-if="is_help_panel_open || tab == 'help'" ref="help_panel" :portrait_view="portrait_view" @close="is_help_panel_open = false; setTab(previous_tab)"></help-panel>
+		<help-panel v-if="is_help_panel_open || tab == 'help'" ref="help_panel" :portrait_view="portrait_view" @close="is_help_panel_open = false; portrait_view && setTab(previous_tab);"></help-panel>
 
 
 		<div class="resizer"
@@ -127,7 +127,7 @@ export default {
 		},
 		async openHelpPage(tab_key, group_key) {
 			this.is_help_panel_open = true;
-			this.setTab('help');
+			if (portrait_view) this.setTab('help');
 			await Vue.nextTick();
 			this.$refs.help_panel.openPage(tab_key, group_key);
 		},

package.json

@@ -5,30 +5,32 @@
 			<a class="back_button" v-if="category_key" @click="openPage('', '')"><ChevronLeft :size="20" /> Back to overview</a>
 		</div>
 
-		<content v-if="!category_key">
-			<h1>Documentation</h1>
-			<ul>
-				<li v-for="(cat, cat_key) in HelpData">
-					<span class="category_title">{{ cat.title }}</span>
-					<ul>
-						<li v-for="(pg, pg_key) in HelpData[cat_key].pages" class="clickable" @click="openPage(cat_key, pg_key)">{{ pg.title }}</li>
-					</ul>
-				</li>
-			</ul>
-		</content>
-		<content v-else-if="page">
+		<content ref="content">
+			<template v-if="!category_key">
+				<h1>Documentation</h1>
+				<ul>
+					<li v-for="(cat, cat_key) in HelpData">
+						<span class="category_title">{{ cat.title }}</span>
+						<ul>
+							<li v-for="(pg, pg_key) in HelpData[cat_key].pages" class="clickable" @click="openPage(cat_key, pg_key)">{{ pg.title }}</li>
+						</ul>
+					</li>
+				</ul>
+			</template>
+			<template v-else-if="page">
 
-			<h1>{{ page.title }}</h1>
-			<HelpText v-if="page.text" :text="page.text"></HelpText>
+				<h1>{{ page.title }}</h1>
+				<HelpText v-if="page.text" :text="page.text"></HelpText>
 
-			<HelpInputList v-if="page.inputs" :inputs="page.inputs" :category_key="category_key" :page_key="page_key" />
+				<HelpInputList v-if="page.inputs" :inputs="page.inputs" :category_key="category_key" :page_key="page_key" />
+			</template>
 		</content>
 	</div>
 </template>
 
 <script>
 import HelpData from './../help'
-import { X, ChevronLeft } from 'lucide-vue'
+import { X, ChevronLeft, Watch } from 'lucide-vue'
 import HelpText from './HelpPanel/HelpText.vue';
 import HelpInputList from './HelpPanel/HelpInputList.vue';
 import Vue from 'vue';
@@ -53,6 +55,11 @@ export default {
 	props: {
 		portrait_view: Boolean
 	},
+	watch: {
+		page_key() {
+			this.$refs.content.scrollTop = 0;
+		}
+	},
 	computed: {
 		page() {
 			return HelpData[this.category_key]?.pages[this.page_key];

src/components/App.vue

@@ -25,7 +25,13 @@ function getValue(key, required) {
 	if (type.array) {
 		var result = [];
 		for (var num of value) {
-			result.push(processValue(num, type));
+			let value = processValue(num, type);
+			if (type.type == 'string' && typeof value == 'string' && value.includes('\n')) {
+				let lines = value.split(/\s*\n+\s*/g).filter(line => line.length);
+				result.push(...lines);
+			} else {
+				result.push(value);
+			}
 		}
 		if (!result.find(v => v) && !required) result = undefined;
 	} else {

src/components/HelpPanel.vue

@@ -84,7 +84,7 @@ export default {
 						text: [
 							'An identifier consists of two parts: The project namespace, and the particle name. The namespace is always separated by a colon',
 							'The identifier should be all in lower-case letters and use underscores to separate words. Letters from a-z, numbers, points and underscores are allowed, other characters may cause issues.',
-							'Example: `snowstorm:fire`',
+							'Example: snowstorm:fire',
 							'The identifier can be used in-game to reference the particle effect, for example in particle commands, scripts, or entities.'
 						]
 					},
@@ -128,7 +128,7 @@ export default {
 						type: 'select',
 						text: [
 							{type: 'h3', text: 'Steady'},
-							'Particles are spawned steadily over the lifetime of the emitter',
+							'Particles are spawned steadily during the lifetime of the emitter',
 							{type: 'h3', text: 'Instant'},
 							'All particles are spawned instantly at the start of the emitter\'s lifetime',
 							{type: 'h3', text: 'Manual'},
@@ -155,6 +155,14 @@ export default {
 				inputs: {
 					mode: {
 						type: 'select',
+						text: [
+							{type: 'h3', text: 'Looping'},
+							'Emitter will loop until it is removed.',
+							{type: 'h3', text: 'Once'},
+							'Emitter will execute once, and once the lifetime ends or the number of particles allowed to emit have emitted, the emitter expires.',
+							{type: 'h3', text: 'Expression'},
+							'Emitter will turn "on" when the activation expression is non-zero, and will turn "off" when it\'s zero. This is useful for situations like driving an entity-attached emitter from an entity variable.'
+						]
 					},
 					active_time: {
 						type: 'molang',
@@ -388,7 +396,7 @@ export default {
 							{type: 'h3', text: 'Blend'},
 							'Blend supports partial transparency in pixels. Note that with this material, particles of different colors, even from different effect, can cause visual flickering in-game when viewed behind each other.',
 							{type: 'h3', text: 'Additive'},
-							'Partial transparency is supported. Particles are stacked on top of each other using additive blending. This is ideal for creating light effects.',
+							'Partial transparency is supported. Particles are rendered additive blending. This is ideal for creating light effects.',
 							{type: 'h3', text: 'Opaque'},
 							'The particle is fully opaque, no transparent pixels are supported.',
 							{type: 'h3', text: 'Custom:'},
@@ -482,6 +490,7 @@ export default {
 						type: 'color',
 					},
 					expression: {
+						label: 'Color Expression',
 						type: 'molang',
 						context: 'particle',
 						evaluation: 'per_tick',
@@ -506,7 +515,7 @@ export default {
 						type: 'image',
 						label: 'Image',
 						text: [
-							'In VS Code, the image gets loaded from the provided texture path automatically. To use this, ensure that you open the entire texture pack folder as a project in VSCode, rather than just the individual particle file.',
+							'In VS Code, the image gets loaded from the provided texture path automatically. To use this, ensure that you open the entire texture pack folder as a project in VSCode, not just the individual particle file.',
 							'In the web app, you need to upload your PNG file to preview it, unless you are using one of the included vanilla particle files.',
 							'Painting on the texture is supported using the provided editing tools.'
 						]
@@ -530,7 +539,7 @@ export default {
 					},
 					size: {
 						type: 'number',
-						text: 'This size is used to set a base size for the UV map. This does not have to match the actual texture resolution, but the aspect ratio should be the same.'
+						text: 'This size is used to set a base size for the UV map. This does not have to be identical to the actual texture resolution, but the aspect ratio should match.'
 					},
 					uv: {
 						type: 'number',

src/export.js

@@ -629,7 +629,7 @@ const Data = {
 				max_frame: new Input({
 					id: 'particle_texture_max_frame',
 					label: 'Max Frame',
-					info: 'Maximum amount of frames to draw from the flipbook',
+					info: 'Maximum amount of animation frames to draw from the flipbook',
 					enabled_modes: ['animated']
 				}),
 				stretch_to_lifetime: new Input({
@@ -677,15 +677,15 @@ const Data = {
 				expire_in: new Input({
 					id: 'particle_lifetime_expire_in',
 					label: 'Kill in Blocks',
-					info: 'List of blocks to that let the particle expire on contact. Block IDs have a namespace and are separated by a space character.',
+					info: 'List of blocks that let the particle expire on contact. Enter the block IDs including the namespace.',
 					placeholder: 'minecraft:stone',
 					axis_count: -1,
 					type: 'text'
 				}),
 				expire_outside: new Input({
 					id: 'particle_lifetime_expire_outside',
 					label: 'Only in Blocks',
-					info: 'List of blocks outside of which the particle expires. Block IDs have a namespace and are separated by a space character.',
+					info: 'List of blocks outside of which the particle expires. Enter the block IDs including the namespace.',
 					placeholder: 'minecraft:air',
 					axis_count: -1,
 					type: 'text'

src/help.js

@@ -2,8 +2,8 @@
 	"name": "snowstorm",
 	"displayName": "Snowstorm",
 	"description": "Minecraft Bedrock Edition particle editor",
-	"version": "3.1.0",
-	"enableProposedApi": false,
+	"version": "3.2.0",
+	"enabledApiProposals": [],
 	"publisher": "JannisX11",
 	"engines": {
 		"vscode": "^1.44.0"