diff --git a/.gitignore b/.gitignore
index ea4a0dade..b97c00845 100644
--- a/.gitignore
+++ b/.gitignore
@@ -50,6 +50,9 @@
# /plugins_src/autouv/
/plugins_src/autouv/autouv_en.lang
+# /plugins_src/scripting/docs/generated/
+/plugins_src/scripting/docs/generated/*
+
# /plugins_src/fbx/
/plugins_src/fbx/*.o
/plugins_src/fbx/*.obj
diff --git a/plugins/scripting/README b/plugins/scripting/README
new file mode 100644
index 000000000..61eaea1b1
--- /dev/null
+++ b/plugins/scripting/README
@@ -0,0 +1 @@
+This directory contains the scripting plugin.
diff --git a/plugins/scripting/wpc_scripting_shapes_init/README b/plugins/scripting/wpc_scripting_shapes_init/README
new file mode 100644
index 000000000..a5d1aa3b3
--- /dev/null
+++ b/plugins/scripting/wpc_scripting_shapes_init/README
@@ -0,0 +1 @@
+This directory contains files for the scripting plugin.
diff --git a/plugins/scripting/wpc_scripting_shapes_init/py/README b/plugins/scripting/wpc_scripting_shapes_init/py/README
new file mode 100644
index 000000000..06724e6c5
--- /dev/null
+++ b/plugins/scripting/wpc_scripting_shapes_init/py/README
@@ -0,0 +1 @@
+This directory contains the python files for scripting.
diff --git a/plugins/scripting/wpc_scripting_shapes_init/scm/README b/plugins/scripting/wpc_scripting_shapes_init/scm/README
new file mode 100644
index 000000000..cedf160c8
--- /dev/null
+++ b/plugins/scripting/wpc_scripting_shapes_init/scm/README
@@ -0,0 +1 @@
+This directory contains the scheme files for scripting.
diff --git a/plugins_src/Makefile b/plugins_src/Makefile
index e94ad5933..03ac52f0f 100644
--- a/plugins_src/Makefile
+++ b/plugins_src/Makefile
@@ -51,6 +51,7 @@ subdirs:
(cd primitives; $(MAKE))
(cd commands; $(MAKE))
(cd autouv; $(MAKE))
+ (cd scripting; $(MAKE))
template: opt
$(ERL) -pa $(WINGS_INTL) -noinput -run tools generate_template_files $(EBIN)
@@ -64,6 +65,7 @@ subdirs_lang:
(cd primitives; $(MAKE) lang)
(cd commands; $(MAKE) lang)
(cd autouv; $(MAKE) lang)
+ (cd scripting; $(MAKE) lang)
clean: subdirs_clean
rm -f $(TARGET_FILES)
@@ -74,6 +76,7 @@ subdirs_clean:
(cd primitives; $(MAKE) clean)
(cd commands; $(MAKE) clean)
(cd autouv; $(MAKE) clean)
+ (cd scripting; $(MAKE) clean)
$(EBIN)/%.beam: $(ESRC)/%.erl
$(ERLC) $(ERL_COMPILE_FLAGS) -o$(EBIN) $<
diff --git a/plugins_src/scripting/Makefile b/plugins_src/scripting/Makefile
new file mode 100644
index 000000000..68bf5dc12
--- /dev/null
+++ b/plugins_src/scripting/Makefile
@@ -0,0 +1,125 @@
+#
+# Makefile --
+#
+# Makefile for building plug-ins for scripting.
+#
+# Copyright (c) 2001-2013 Bjorn Gustavsson
+#
+# See the file "license.terms" for information on usage and redistribution
+# of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+#
+# $Id: Makefile,v 1.14 2006/08/02 22:44:40 antoneos Exp $
+#
+include ../../erl.mk
+
+.SUFFIXES: .erl .jam .beam .yrl .xrl .bin .mib .hrl .sgml .html .ps .3 .1 \
+ .fig .dvi .tex .class .java .pdf .psframe .pscrop
+
+ESRC=.
+WINGS_INTL=../../intl_tools
+EBIN=../../plugins/scripting
+WINGS_TOP=../../..
+WINGS_E3D=../../e3d
+
+ifeq ($(TYPE),debug)
+TYPE_FLAGS=-DDEBUG
+else
+TYPE_FLAGS=
+endif
+
+MODULES= \
+ wpc_scripting_shapes \
+ scripting_engines
+
+INIT_SCRIPT_SRC=$(ESRC)/init_scripts
+INIT_SCRIPT_EBIN=$(EBIN)/wpc_scripting_shapes_init
+INIT_SCRIPT_PY_SRC=$(INIT_SCRIPT_SRC)/py
+INIT_SCRIPT_PY_EBIN=$(INIT_SCRIPT_EBIN)/py
+INIT_SCRIPT_SCM_SRC=$(INIT_SCRIPT_SRC)/scm
+INIT_SCRIPT_SCM_EBIN=$(INIT_SCRIPT_EBIN)/scm
+
+TARGET_FILES= $(MODULES:%=$(EBIN)/%.beam)
+
+
+# ----------------------------------------------------
+# FLAGS
+# ----------------------------------------------------
+ERL_COMPILE_FLAGS += -Werror +nowarn_match_float_zero -I $(WINGS_TOP) \
+ $(TYPE_FLAGS) -pa $(WINGS_INTL) +debug_info
+# ----------------------------------------------------
+# Targets
+# ----------------------------------------------------
+
+opt debug:
+ $(MAKE) TYPE=$@ common
+
+template: opt
+ $(ERL) -pa $(WINGS_INTL) -noinput -run tools generate_template_files $(EBIN)
+
+lang: template
+ cp *.lang $(EBIN)
+ $(ERL) -pa $(WINGS_INTL) -noinput -run tools diff_lang_files $(EBIN)
+
+common: $(TARGET_FILES) $(INIT_SCRIPT_EBIN) subdirs
+
+subdirs:
+ (cd docs; $(MAKE))
+
+clean:
+ rm -f $(TARGET_FILES)
+ rm -f core
+ (cd docs; $(MAKE) clean)
+
+SH?=sh
+
+$(EBIN)/%.beam: $(ESRC)/%.erl
+ $(ERLC) $(ERL_COMPILE_FLAGS) -o$(EBIN) $<
+
+PY_FILES= init w3d_e3d w3d_int w3d_newshape
+PY_FILES_1=$(PY_FILES:%=$(INIT_SCRIPT_PY_EBIN)/%.py)
+
+SCM_FILES= init_env_csi init_env_gauche
+SCM_FILES_1=$(SCM_FILES:%=$(INIT_SCRIPT_SCM_EBIN)/%.scm)
+
+$(INIT_SCRIPT_EBIN): $(INIT_SCRIPT_EBIN)/callable.conf \
+ $(INIT_SCRIPT_EBIN)/defaults.conf \
+ $(INIT_SCRIPT_EBIN)/python.script-init-conf \
+ $(INIT_SCRIPT_EBIN)/scheme.script-init-conf \
+ $(INIT_SCRIPT_PY_EBIN)/w3d_we.py \
+ $(INIT_SCRIPT_SCM_EBIN)/init.scm \
+ $(PY_FILES_1) \
+ $(SCM_FILES_1)
+
+
+$(INIT_SCRIPT_EBIN)/%.conf: $(INIT_SCRIPT_SRC)/%.conf
+ cp $< $(INIT_SCRIPT_EBIN)/
+$(INIT_SCRIPT_EBIN)/%.script-init-conf: $(INIT_SCRIPT_SRC)/%.script-init-conf
+ cp $< $(INIT_SCRIPT_EBIN)/
+$(INIT_SCRIPT_PY_EBIN)/%.py: $(INIT_SCRIPT_PY_SRC)/%.py
+ cp $< $(INIT_SCRIPT_PY_EBIN)/
+$(INIT_SCRIPT_SCM_EBIN)/%.scm: $(INIT_SCRIPT_SCM_SRC)/%.scm
+ cp $< $(INIT_SCRIPT_SCM_EBIN)/
+
+# Generate w3d_we.py file from callable.conf
+$(INIT_SCRIPT_PY_EBIN)/w3d_we.py: $(INIT_SCRIPT_PY_SRC)/w3d_we.1.py \
+ $(INIT_SCRIPT_SRC)/callable.conf \
+ $(INIT_SCRIPT_SRC)/py-modnames
+ $(SH) ./tools/gen-init-we-script.sh \
+ "$(INIT_SCRIPT_PY_SRC)/w3d_we.1.py" \
+ - \
+ "$(INIT_SCRIPT_SRC)/callable.conf" \
+ "$(INIT_SCRIPT_SRC)/py-modnames" py \
+ > "$(INIT_SCRIPT_PY_EBIN)/w3d_we.py"
+
+# Generate init.scm file from callable.conf
+$(INIT_SCRIPT_SCM_EBIN)/init.scm: $(INIT_SCRIPT_SCM_SRC)/init.1.scm \
+ $(INIT_SCRIPT_SRC)/callable.conf \
+ $(INIT_SCRIPT_SRC)/scm-modnames \
+ $(INIT_SCRIPT_SCM_SRC)/init.2.scm
+ $(SH) ./tools/gen-init-we-script.sh \
+ "$(INIT_SCRIPT_SCM_SRC)/init.1.scm" \
+ "$(INIT_SCRIPT_SCM_SRC)/init.2.scm" \
+ "$(INIT_SCRIPT_SRC)/callable.conf" \
+ "$(INIT_SCRIPT_SRC)/scm-modnames" scm \
+ > "$(INIT_SCRIPT_SCM_EBIN)/init.scm"
+
diff --git a/plugins_src/scripting/docs/Makefile b/plugins_src/scripting/docs/Makefile
new file mode 100644
index 000000000..b6466d6d4
--- /dev/null
+++ b/plugins_src/scripting/docs/Makefile
@@ -0,0 +1,108 @@
+#
+# Makefile --
+#
+# Makefile for building scripting documentation
+#
+# Copyright (c) 2025 Edward Blake
+#
+# See the file "license.terms" for information on usage and redistribution
+# of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+#
+
+AWK?=awk
+MKDIR?=mkdir -p
+PACK_MANUAL?=../../../tools/pack_manual
+ESCRIPT?=escript
+
+FILES= \
+ en/INDEX \
+ en/README.txt \
+ en/wscr/intro.txt \
+ en/wscr/langfiles.txt \
+ en/wscr/pluginscripts.txt \
+ en/wscr/query.txt \
+ en/wscr/scriptfolders.txt \
+ en/wscr/directives/type.txt \
+ en/wscr/directives/name.txt \
+ en/wscr/directives/mode.txt \
+ en/wscr/directives/desc.txt \
+ en/wscr/directives/include.txt \
+ en/wscr/directives/params_title.txt \
+ en/wscr/directives/params_templates.txt \
+ en/wscr/directives/template.txt \
+ en/wscr/directives/params.txt \
+ en/wscr/directives/param.txt \
+ en/wscr/directives/extensions.txt \
+ en/wscr/directives/params_init.txt \
+ en/wscr/directives/params_set.txt \
+ en/wscr/directives/export_param.txt \
+ en/wscr/directives/import_param.txt \
+ en/wscr/directives/adv_param.txt \
+ en/wscr/directives/params_preview.txt \
+ en/wscr/directives/command_changes.txt \
+ en/wscr/directives/command_inputs.txt \
+ en/wscr/directives/extra_file.txt \
+ en/wscr/directives/script_param.txt \
+ en/wscr/directives/hradio.txt \
+ en/wscr/directives/menu.txt \
+ en/wscr/directives/browse.txt \
+ en/wscr/directives/checkbox.txt \
+ en/wscr/directives/vradio.txt \
+ en/scheme/command_scripts.txt \
+ en/scheme/exporter_scripts.txt \
+ en/scheme/importer_scripts.txt \
+ en/scheme/intro.txt \
+ en/scheme/langres.txt \
+ en/scheme/new_shape_scripts.txt \
+ en/scheme/functions/e3d_face.txt \
+ en/scheme/functions/e3d_file.txt \
+ en/scheme/functions/e3d_image.txt \
+ en/scheme/functions/e3d_mesh.txt \
+ en/scheme/functions/e3d_object.txt \
+ en/python/command_scripts.txt \
+ en/python/exporter_scripts.txt \
+ en/python/importer_scripts.txt \
+ en/python/intro.txt \
+ en/python/langres.txt \
+ en/python/new_shape_scripts.txt \
+ en/python/functions/e3d_face.txt \
+ en/python/functions/e3d_file.txt \
+ en/python/functions/e3d_image.txt \
+ en/python/functions/e3d_mesh.txt \
+ en/python/functions/e3d_object.txt \
+ en/python/functions/list_of_arrays.txt \
+ en/python/functions/list_of_tuples.txt \
+ en/python/functions/material.txt \
+ en/python/functions/material_maps.txt \
+ en/python/functions/material_opengl.txt \
+ en/python/functions/new_shape.txt \
+ en/python/functions/output_list.txt
+
+SCRIPTINITDIR=../../../plugins/scripting/wpc_scripting_shapes_init
+
+all: ${SCRIPTINITDIR}/scripting-reference-en.manual
+
+clean:
+ rm generated/en/scm-we.txt
+ rm generated/en/py-we.txt
+ rmdir generated/en
+ rmdir generated
+
+
+generated/en:
+ $(MKDIR) generated/en
+
+generated/en/scm-we.txt: generated/en funs
+ $(AWK) -v type=scm -f ../tools/gen-funs-doc.awk < funs > generated/en/scm-we.txt
+
+generated/en/py-we.txt: generated/en funs
+ $(AWK) -v type=py -f ../tools/gen-funs-doc.awk < funs > generated/en/py-we.txt
+
+${SCRIPTINITDIR}/scripting-reference-en.manual: $(FILES) \
+ generated/en/scm-we.txt \
+ generated/en/py-we.txt
+ $(ESCRIPT) $(PACK_MANUAL) en \
+ --out ${SCRIPTINITDIR}/scripting-reference-en.manual
+
+
+
diff --git a/plugins_src/scripting/docs/en/INDEX b/plugins_src/scripting/docs/en/INDEX
new file mode 100644
index 000000000..0bcb3942d
--- /dev/null
+++ b/plugins_src/scripting/docs/en/INDEX
@@ -0,0 +1,94 @@
+{info,[
+ {title, "Scripting Reference"},
+ {language, "en"}
+]}.
+{txt, "README", "README.txt"}.
+{"Scripting Information",[
+ {"Introduction",[
+ {txt, "Introduction", "wscr/intro.txt"},
+ {txt, "Script Folders", "wscr/scriptfolders.txt"},
+ {txt, "Plugin Scripts", "wscr/pluginscripts.txt"},
+ {txt, "Language files", "wscr/langfiles.txt"},
+ {txt, "Query Mini Language", "wscr/query.txt"}
+ ]},
+ {"Directive Reference",[
+ {txt, "type Directive", "wscr/directives/type.txt"},
+ {txt, "name Directive", "wscr/directives/name.txt"},
+ {txt, "mode Directive", "wscr/directives/mode.txt"},
+ {txt, "desc Directive", "wscr/directives/desc.txt"},
+ {txt, "include Directive", "wscr/directives/include.txt"},
+ {txt, "params_title Directive", "wscr/directives/params_title.txt"},
+ {txt, "params_templates Directive", "wscr/directives/params_templates.txt"},
+ {txt, "template Directive", "wscr/directives/template.txt"},
+ {txt, "params Directive", "wscr/directives/params.txt"},
+ {txt, "param Directive", "wscr/directives/param.txt"},
+ {txt, "extensions Directive", "wscr/directives/extensions.txt"},
+ {txt, "params_init Directive", "wscr/directives/params_init.txt"},
+ {txt, "params_set Directive", "wscr/directives/params_set.txt"},
+ {txt, "export_param Directive", "wscr/directives/export_param.txt"},
+ {txt, "import_param Directive", "wscr/directives/import_param.txt"},
+ {txt, "adv_param Directive", "wscr/directives/adv_param.txt"},
+ {txt, "params_preview Directive", "wscr/directives/params_preview.txt"},
+ {txt, "script_param Directive", "wscr/directives/script_param.txt"},
+ {txt, "extra_file Directive", "wscr/directives/extra_file.txt"},
+ {txt, "command_inputs Directive", "wscr/directives/command_inputs.txt"},
+ {txt, "command_changes Directive", "wscr/directives/command_changes.txt"},
+ {txt, "hradio Directive", "wscr/directives/hradio.txt"},
+ {txt, "menu Directive", "wscr/directives/menu.txt"},
+ {txt, "browse Directive", "wscr/directives/browse.txt"},
+ {txt, "checkbox Directive", "wscr/directives/checkbox.txt"},
+ {txt, "vradio Directive", "wscr/directives/vradio.txt"}
+ ]}
+]}.
+{"Python",[
+ {"Introduction",[
+ {txt, "Online Resources for the Python Language", "python/langres.txt"},
+ {txt, "Python Intro", "python/intro.txt"},
+ {txt, "New Shape Scripts", "python/new_shape_scripts.txt"},
+ {txt, "Command Scripts", "python/command_scripts.txt"},
+ {txt, "Importer Scripts", "python/importer_scripts.txt"},
+ {txt, "Exporter Scripts", "python/exporter_scripts.txt"}
+ ]},
+ {"OutputList Function Reference",[
+ {txt, "OutputList", "python/functions/output_list.txt"}
+ ]},
+ {"NewShape (w3d_newshape) Function Reference",[
+ {txt, "ListOfArrays", "python/functions/list_of_arrays.txt"},
+ {txt, "ListOfTuples", "python/functions/list_of_tuples.txt"},
+ {txt, "NewShape", "python/functions/new_shape.txt"}
+ ]},
+ {"E3D (w3d_e3d) Function Reference",[
+ {txt, "E3DFace", "python/functions/e3d_face.txt"},
+ {txt, "E3DMesh", "python/functions/e3d_mesh.txt"},
+ {txt, "E3DObject", "python/functions/e3d_object.txt"},
+ {txt, "E3DImage", "python/functions/e3d_image.txt"},
+ {txt, "MaterialMaps", "python/functions/material_maps.txt"},
+ {txt, "MaterialOpenGLAttributes", "python/functions/material_opengl.txt"},
+ {txt, "Material", "python/functions/material.txt"},
+ {txt, "E3DFile", "python/functions/e3d_file.txt"}
+ ]},
+ {"We (w3d_we) Function Reference",[
+ {txt, "we", "../generated/en/py-we.txt"}
+ ]}
+]}.
+{"Scheme",[
+ {"Introduction",[
+ {txt, "Online Resources for the Scheme Language", "scheme/langres.txt"},
+ {txt, "Scheme Intro", "scheme/intro.txt"},
+ {txt, "New Shape Scripts", "scheme/new_shape_scripts.txt"},
+ {txt, "Command Scripts", "scheme/command_scripts.txt"},
+ {txt, "Importer Scripts", "scheme/importer_scripts.txt"},
+ {txt, "Exporter Scripts", "scheme/exporter_scripts.txt"}
+ ]},
+ {"E3D Function Reference",[
+ {txt, "e3d_face", "scheme/functions/e3d_face.txt"},
+ {txt, "e3d_mesh", "scheme/functions/e3d_mesh.txt"},
+ {txt, "e3d_object", "scheme/functions/e3d_object.txt"},
+ {txt, "e3d_file", "scheme/functions/e3d_file.txt"},
+ {txt, "e3d_image", "scheme/functions/e3d_image.txt"}
+ ]},
+ {"We Function Reference",[
+ {txt, "we", "../generated/en/scm-we.txt"}
+ ]}
+]}.
+
diff --git a/plugins_src/scripting/docs/en/README.txt b/plugins_src/scripting/docs/en/README.txt
new file mode 100644
index 000000000..4761a2a52
--- /dev/null
+++ b/plugins_src/scripting/docs/en/README.txt
@@ -0,0 +1,18 @@
+Scripting Plugin for Wings3D
+
+This reference contains three sections:
+
+Script Information (.wscr)
+
+Scheme Scripting
+
+Python Scripting
+
+
+CONTRIBUTORS FOR DOCUMENTATION
+
+Edward Blake has written the documentation for the first
+release of the scripting plugin.
+
+
+
diff --git a/plugins_src/scripting/docs/en/python/command_scripts.txt b/plugins_src/scripting/docs/en/python/command_scripts.txt
new file mode 100644
index 000000000..cc1bb05a9
--- /dev/null
+++ b/plugins_src/scripting/docs/en/python/command_scripts.txt
@@ -0,0 +1,230 @@
+Command Scripts
+
+Command scripts are available when right clicking on a selected object.
+
+The "points" extra parameter is needed to access the list of vertices, which come as a vertice number and a 3 dimensional position.
+
+
+import w3d_int
+
+def main(params, params_by_key, extra_params):
+ points = w3d_int.Points()
+ points.load_from(extra_params["points"])
+
+ ##
+ ## ...
+ ##
+
+ ## Return new points positions
+ return [w3d_int.SetPoints(points)]
+
+w3d_main_function = main
+
+import w3d_int
+
+def command(params, params_by_key, extra_params):
+ op = extra_params["op"]
+ points = w3d_int.Points()
+ points.load_from(extra_params["points"])
+
+ newpoints = []
+ for pair in points.list:
+ x = pair[1][0] + 0.5
+ y = pair[1][1] + 0.5
+ z = pair[1][2] + 0.5
+ newpoints.append((pair[0], (x,y,z)))
+ return [w3d_int.SetPoints(newpoints)]
+
+w3d_main_function = main
+
+type "py"
+name ?__(1,"Example Simple Script")
+desc ?__(2,"Example Simple Script")
+mode "body"
+params_title ?__(3,"Example Simple Script")
+command_inputs "points"
+command_changes "points"
+params {
+ param "Unused" 0.0
+}
+
+import w3d_int
+
+def command(params, params_by_key, extra_params):
+ op = extra_params["op"]
+ val = params[0]
+ points = w3d_int.Points()
+ points.load_from(extra_params["points"])
+
+ newpoints = []
+ for pair in points.list:
+ x = pair[1][0] + val
+ y = pair[1][1] + val
+ z = pair[1][2] + val
+ newpoints.append((pair[0], (x,y,z)))
+ return [w3d_int.SetPoints(newpoints)]
+
+w3d_main_function = main
+
+type "py"
+name ?__(1,"Example Simple Script")
+desc ?__(2,"Example Simple Script")
+mode "body"
+params_title ?__(3,"Example Simple Script")
+command_inputs "points"
+command_changes "points"
+params {
+ param "Move" 0.5
+}
+
+command_inputs "points"
+command_changes "points"
+
+command_inputs "e3d_mesh"
+command_changes "e3d_mesh"
+
+from w3d_e3d import E3DMesh, SetE3DMesh
+
+def command(params, params_by_key, extra_params):
+ op = extra_params["op"]
+ mesh = E3DMesh()
+ mesh.load_from(extra_params["e3d_mesh"])
+
+ return [SetE3DMesh(mesh)]
+
+w3d_main_function = command
+
+from w3d_e3d import E3DMesh, SetE3DMesh
+
+def command(params, params_by_key, extra_params):
+ op = extra_params["op"]
+ mesh = E3DMesh()
+ mesh.load_from(extra_params["e3d_mesh"])
+
+ points = mesh.vs
+
+ newpoints = []
+ for (x,y,z) in points:
+ newpoints.append((x + 0.5, y + 0.5, z + 0.5))
+
+ mesh.vs = newpoints
+
+ return [SetE3DMesh(mesh)]
+
+w3d_main_function = command
+
+type "py"
+name ?__(1,"Example E3D Mesh Script")
+desc ?__(2,"Example E3D Mesh Script")
+mode "body"
+params_title ?__(3,"Example E3D Mesh Script")
+command_inputs "e3d_mesh"
+command_changes "e3d_mesh"
+params {
+ param "Unused" 0.0
+}
+
+import w3d_we
+
+def command(params, params_by_key, extra_params):
+ op = extra_params["op"]
+
+ move_x = 0.5
+ move_y = 0.5
+ move_z = 0.5
+ w3d_we.we__transform_vs([
+ 1.0, 0.0, 0.0,
+ 0.0, 1.0, 0.0,
+ 0.0, 0.0, 1.0,
+ move_x, move_y, move_z])
+
+ return []
+
+w3d_main_function = command
+
+type "py"
+name ?__(1,"Example We Script")
+desc "Example We Script"
+mode "body"
+params_title ?__(2,"Example We Script")
+params_preview 1
+params {
+ param "Unused" 0.0
+}
+
+def main(params, params_by_key, extra_params):
+ filename = extra_params["filename"]
+ content = w3d_e3d.E3DFile()
+ content.load_from(extra_params["content"])
+
+ ##
+ ## ...
+ ##
+
+ ## Return Okay() if the file was written successfully.
+ return Okay()
+
+w3d_main_function = main
+
+ return Okay()
+
+import w3d_e3d
+from os import path
+
+def export_fun(attr, filename, content):
+ objs = content.objs
+ with open(filename, "w", encoding="utf-8") as fp:
+ # Number of objects
+ fp.write(str(len(objs)) + "\n")
+ for obj in objs:
+ mesh = obj.obj
+ vs = mesh.vs
+ faces = mesh.fs
+ # Object name
+ fp.write(str(obj.name) + "\n")
+ # Number of vertices
+ fp.write(str(len(vs)) + "\n")
+ for v in vs:
+ x = v[0]
+ y = v[1]
+ z = v[2]
+ # Vertice coordinate
+ fp.write(str(x) + " " + str(y) + " " + str(z) + "\n")
+ # Number of faces
+ fp.write(str(len(faces)) + "\n")
+ for face in faces:
+ vlist = face.vs
+ for v in vlist:
+ fp.write(str(v) + " ")
+ fp.write("\n")
+
+ return Okay()
+
+def exporter(params, params_by_key, extra_params):
+ filename = extra_params["filename"]
+ content = w3d_e3d.E3DFile()
+ content.load_from(extra_params["content"])
+ return export_fun({}, filename, content)
+
+w3d_main_function = exporter
+
+type "py"
+name ?__(1,"Example Exporter (.txt)")
+mode "export"
+params_title ?__(3,"Example Exporter Settings")
+params_templates {
+ template export include_normals,include_uvs,include_colors
+}
+params_set {
+ export_param include_uvs %[bool(params/include_uvs)]
+ export_param subdivisions %[params/subdivisions]
+ export_param include_normals %[bool(params/include_normals)]
+ export_param include_hard_edges 'true'
+ export_param script_texture_convert 'user'
+}
+extensions {
+ ext .txt ?__(5,"Text Mesh")
+}
+
+b = w3d_e3d.E3DFile()
+b.objs.append(E3DObject())
+o_ok = OutputList()
+o_ok.add_symbol("ok")
+o_ok.add_list(b.as_output_list())
+o_ok.write_list_out(sys.stdout)
+
+content = w3d_e3d.E3DFile()
+content.load_from(extra_params["content"])
+
+e3d_o = w3d_e3d.E3DObject()
+e3d_o.obj = mesh
+shp = w3d_newshape.NewShape()
+shp.prefix = "shape"
+shp.obj = e3d_o
+o = shp.as_output_list()
+o.write_list_out(sys.stdout)
+
+def main(params, params_by_key, extra_params):
+ filename = extra_params["filename"]
+
+ ##
+ ## ...
+ ##
+
+ e3df = E3DFile()
+
+ ## After reading the file, return e3df
+ return Okay(ed3f)
+
+w3d_main_function = main
+
+ e3df = w3d_e3d.E3DFile()
+ e3df.objs = [obj] # obj is an E3DObject
+ return Okay(e3df)
+
+import w3d_e3d
+from os import path
+
+def import_fun(attr, filename):
+ with open(filename, "r", encoding="utf-8") as fp:
+ # Number of objects
+ num_objs = int(fp.readline().rstrip())
+ objs = []
+ # Read each object
+ for i in range(0, num_objs):
+ # Object name
+ objname = fp.readline().rstrip()
+ # Number of vertices
+ num_vs = int(fp.readline().rstrip())
+ vs = []
+ for i2 in range(0, num_vs):
+ v = fp.readline().rstrip().split(" ")
+ vs.append((float(v[0]),float(v[1]),float(v[2])))
+ # Number of faces
+ num_faces = int(fp.readline().rstrip())
+ faces = []
+ for i2 in range(0, num_faces):
+ # Vertex indices
+ vf0 = fp.readline().rstrip().split(" ")
+ vf = []
+ for v in vf0:
+ vf.append(int(v))
+ face = w3d_e3d.E3DFace()
+ face.vs = vf
+ face.vc = []
+ face.tx = []
+ face.ns = []
+ faces.append(face)
+
+ mesh = w3d_e3d.E3DMesh()
+ mesh.type="polygon"
+ mesh.vs=vs
+ mesh.fs=faces
+ mesh.vc=[]
+ mesh.tx=[]
+ mesh.ns=[]
+ mesh.he=[]
+ obj = w3d_e3d.E3DObject()
+ obj.name = objname
+ obj.obj = mesh
+ objs.append(obj)
+
+ e3df = w3d_e3d.E3DFile()
+ e3df.objs = objs
+ return Okay(e3df)
+
+def importer(params, params_by_key, extra_params):
+ filename = extra_params["filename"]
+ return import_fun({}, filename)
+
+w3d_main_function = importer
+
+type "py"
+name ?__(1,"Example Importer (.txt)")
+mode "import"
+params_title ?__(3,"Example Importer Settings")
+params_templates {
+ template import
+}
+params_set {
+ import_param script_texture_convert 'auto'
+}
+extensions {
+ ext .txt ?__(5,"Text Mesh")
+}
+.wscr File
+
+For your script to be able to appear in the script chooser dialog, you will need to make a wscr file with the same base name as your main python script file. For example, if your script file is example.py, your wscr file should be named example.wscr. The name that appears in the script chooser is the name specified in the wscr file.
+
+Initial Bootstrap Script
+
+A bootstrap script that comes with the script plugin is first launched which then defines some basic functions, sometimes adds include paths, and gets from stdin the actual script being invoked as well as parameters that goes with it.
+
+Parameters that are passed in
+
+When a script is invoked, parameters from the dialog box are passed in, other parameters are also passed in depending on the type of script.
+
+Returning values from the script
+
+Scripts write to stdout an OutputList before exiting.
+
+Calling functions in Wings3D from a script
+
+Scripts can communicate with the plugin by setting temporary variables and using queries to call functions and get the return value. Temporary variables makes it easier to input elaborate data structures as arguments by referencing them in the query.
+
+
+Set value to variable:
+
+
+ w3d_int.wings_set_var("var1", [1, 2, 3, 4])
+["ok"]
+ w3d_int.wings_get_var("var1")
+[[1, 2, 3, 4]]
+ w3d_int.wings_query("lists:reverse(<$'var1')")
+[[4, 3, 2, 1]]
Calling We Functions
+
+Most We functions are already wrapped into a defined function, and are covered in the we function reference.
+
+Other functions can be called with
+ wings_we__get(module,fun,*args)
+ wings_we__change(module,fun,*args)
+
+
+
+NewShape (w3d_newshape) Functions
+
+The w3d_newshape module contains NewShape helper classes and can be imported with:
+
+import w3d_newshape
E3D (w3d_e3d) Functions
+
+The w3d_e3d module contains E3D helper classes and can be imported with:
+
+import w3d_e3d
We (w3d_we) Functions
+
+The w3d_we module contains Winged Edge functions for command scripts:
+
+import w3d_we
Long Running Processes
+
+If your script runs for a long time, you want to use the LongRunningProcess class. The LongRunningProcess class continues your script processing in another thread, while sending back keep-alive messages to Wings3D so the program knows that the script has not timed out.
+
+
+class Examp:
+ def run(self):
+ sum = 0
+ for i in range(0, 100000000):
+ sum = sum + i
+
+print("Begin")
+lrp = LongRunningProcess()
+lrp.run(Examp())
+print("Done")
+
+import w3d_newshape
+import sys
+
+def main(params, params_by_key, extra_params):
+ nshp = w3d_newshape.NewShape()
+ nshp.fs = w3d_newshape.ListOfArrays([
+ [0,1,3,2],
+ [6,7,5,4],
+ [1,0,4,5],
+ [2,3,7,6],
+ [0,2,6,4],
+ [3,1,5,7]
+ ])
+ nshp.vs = w3d_newshape.ListOfTuples([
+ (-2.0, 0.5,-2.0),
+ (-2.0, 0.5, 2.0),
+ ( 2.0, 0.5,-2.0),
+ ( 2.0, 0.5, 2.0),
+ (-2.0,-0.5,-2.0),
+ (-2.0,-0.5, 2.0),
+ ( 2.0,-0.5,-2.0),
+ ( 2.0,-0.5, 2.0)
+ ])
+ return nshp
+
+w3d_main_function = main
+
+type "py"
+name ?__(1,"Example New Shape")
+params_title ?__(3,"Example New Shape")
+params {
+param "Unused" 0.0
+}
+
+import w3d_newshape
+import sys
+
+def main(params, params_by_key, extra_params):
+ xshift = params[0]
+ yshift = params[1]
+ zshift = params[2]
+ nshp = w3d_newshape.NewShape()
+ nshp.fs = w3d_newshape.ListOfArrays([
+ [0,1,3,2],
+ [6,7,5,4],
+ [1,0,4,5],
+ [2,3,7,6],
+ [0,2,6,4],
+ [3,1,5,7]
+ ])
+ nshp.vs = w3d_newshape.ListOfTuples([
+ (-2.0 + xshift, 0.5 + yshift, -2.0 + zshift),
+ (-2.0 + xshift, 0.5 + yshift, 2.0 + zshift),
+ ( 2.0 + xshift, 0.5 + yshift, -2.0 + zshift),
+ ( 2.0 + xshift, 0.5 + yshift, 2.0 + zshift),
+ (-2.0 + xshift, -0.5 + yshift, -2.0 + zshift),
+ (-2.0 + xshift, -0.5 + yshift, 2.0 + zshift),
+ ( 2.0 + xshift, -0.5 + yshift, -2.0 + zshift),
+ ( 2.0 + xshift, -0.5 + yshift, 2.0 + zshift)
+ ])
+ return nshp
+
+w3d_main_function = main
+
+type "py"
+name ?__(1,"Example New Shape")
+params_title ?__(3,"Example New Shape")
+params {
+param "X" 0.0
+param "Y" 0.0
+param "Z" 0.0
+}
+
+import w3d_newshape
+import w3d_e3d
+import sys
+
+def main(params, params_by_key, extra_params):
+ mesh = w3d_e3d.E3DMesh()
+ ...
+ e3d_o = w3d_e3d.E3DObject()
+ e3d_o.obj = mesh
+ nshp = w3d_newshape.NewShape()
+ nshp.prefix = "shape"
+ nshp.obj = e3d_o
+ return nshp
+
+w3d_main_function = main
+
+(main-function
+ (lambda (*params* *extra-params*)
+ ;; The mode of the command: 'body 'face 'vertex 'edge
+ (define op (list-ref
+ (assoc "op" *extra-params*) 1))
+ ;; The list of selected items (if op is 'face , then sel
+ ;; contains a list of face numbers.
+ (define sel (list-ref
+ (assoc "sel" *extra-params*) 1))
+ ;; A "points" list is available if the command_inputs
+ ;; has "points" in its comma-separated list.
+ (define points (list-ref
+ (assoc "points" *extra-params*) 1))
+
+ ;; ...
+
+ ;; Return new positions of vertices
+ (list (list 'set_points points))
+ ))
+
+(main-function
+ (lambda (*params* *extra-params*)
+ (define op (list-ref
+ (assoc "op" *extra-params*) 1))
+ (define points (list-ref
+ (assoc "points" *extra-params*) 1))
+ (define newpoints
+ (map (lambda (p)
+ (define a (vector-ref p 0))
+ (define b (vector-ref p 1))
+ (define x (vector-ref b 0))
+ (define y (vector-ref b 1))
+ (define z (vector-ref b 2))
+ (vector a (vector
+ (+ 0.5 x)
+ (+ 0.5 y)
+ (+ 0.5 z)))
+ ) points))
+ (list (list 'set_points newpoints ))
+ ))
+
+type "scm"
+name ?__(1,"Example Simple Script")
+desc ?__(2,"Example Simple Script")
+mode "body"
+params_title ?__(3,"Example Simple Script")
+command_inputs "points"
+command_changes "points"
+params {
+ param "Unused" 0.0
+}
+
+(main-function
+ (lambda (*params* *extra-params*)
+ (define op (list-ref
+ (assoc "op" *extra-params*) 1))
+ (define points (list-ref
+ (assoc "points" *extra-params*) 1))
+ (define val (list-ref *params* 0))
+ (define newpoints
+ (map (lambda (p)
+ (define a (vector-ref p 0))
+ (define b (vector-ref p 1))
+ (define x (vector-ref b 0))
+ (define y (vector-ref b 1))
+ (define z (vector-ref b 2))
+ (vector a (vector
+ (+ val x)
+ (+ val y)
+ (+ val z)))
+ ) points))
+ (list (list 'set_points newpoints ))
+ ))
+
+type "scm"
+name ?__(1,"Example Simple Script")
+desc ?__(2,"Example Simple Script")
+mode "body"
+params_title ?__(3,"Example Simple Script")
+command_inputs "points"
+command_changes "points"
+params {
+ param "Move" 0.5
+}
+
+command_inputs "points"
+command_changes "points"
+
+command_inputs "e3d_mesh"
+command_changes "e3d_mesh"
+
+(main-function command)
+ (lambda (*params* *extra-params*)
+ (define op (list-ref (assoc "op" *extra-params*) 1))
+ (define mesh (list-ref (assoc "e3d_mesh" *extra-params*) 1))
+
+ (list (list 'set_e3d_mesh mesh))
+ ))
+
+(main-function command)
+ (lambda (*params* *extra-params*)
+ (define op (list-ref (assoc "op" *extra-params*) 1))
+ (define mesh (list-ref (assoc "e3d_mesh" *extra-params*) 1))
+
+ (define points (e3d_mesh-vs mesh))
+
+ (define newpoints #f)
+ (define newmesh #f)
+
+ (set! newpoints
+ (map (lambda (b)
+ (let ((x (vector-ref b 0))
+ (y (vector-ref b 1))
+ (z (vector-ref b 2)))
+ (vector
+ (+ 0.5 x)
+ (+ 0.5 y)
+ (+ 0.5 z)))
+ ) points))
+
+ (set! newmesh
+ (**loader-construct-from `((vs ,newpoints)) mesh (list 'type 'vs 'vc 'tx 'ns 'fs 'he 'matrix))
+ )
+ (list (list 'set_e3d_mesh newmesh))
+ ))
+
+type "scm"
+name ?__(1,"Example E3D Mesh Script")
+desc ?__(2,"Example E3D Mesh Script")
+mode "body"
+params_title ?__(3,"Example E3D Mesh Script")
+command_inputs "e3d_mesh"
+command_changes "e3d_mesh"
+params {
+ param "Unused" 0.0
+}
+
+(main-function command)
+ (lambda (*params* *extra-params*)
+ (define op (list-ref (assoc "op" *extra-params*) 1))
+
+ (define MoveX 0.5)
+ (define MoveY 0.5)
+ (define MoveZ 0.5)
+
+ (we:we:transform_vs!
+ (list 1.0 0.0 0.0
+ 0.0 1.0 0.0
+ 0.0 0.0 1.0
+ MoveX MoveY MoveZ))
+
+ (list)
+ ))
+
+type "scm"
+name ?__(1,"Example We Script")
+desc "Example We Script"
+mode "body"
+params_title ?__(2,"Example We Script")
+params_preview 1
+params {
+ param "Unused" 0.0
+}
+
+(main-function
+ (lambda (*params* *extra-params*)
+ ;; The filename to write to
+ (define filename
+ (list-ref
+ (assoc "filename" *extra-params*) 1))
+ ;; The e3d_file contents
+ (define content
+ (list-ref
+ (assoc "content" *extra-params*) 1))
+
+ ;;
+ ;; ...
+ ;;
+
+ ;; Return '(ok) after successfully writing the file
+ '(ok)
+ ))
+
'(ok)
+(use srfi-1)
+(use srfi-13)
+
+(define (export_fun Attr Filename Contents)
+ (define Objs (e3d_file-objs Contents))
+ (call-with-output-file Filename (lambda (Fp)
+ ;; Number of objects
+ (display (format "~w\n" (length Objs)) Fp)
+ (for-each (lambda (Obj)
+ (define Mesh (e3d_object-obj Obj))
+ (define Name (e3d_object-name Obj))
+ (define Vs (e3d_mesh-vs Mesh))
+ (define Faces (e3d_mesh-fs Mesh))
+ ;; Name of object
+ (display (format "~a\n" Name) Fp)
+ ;; Number of vertices
+ (display (format "~w\n" (length Vs)) Fp)
+ (for-each (lambda (V)
+ (define X (vector-ref V 0))
+ (define Y (vector-ref V 1))
+ (define Z (vector-ref V 2))
+ ;; Vertex coordinates
+ (display (format "~f ~f ~f\n" X Y Z) Fp)
+ ) Vs)
+ ;; Number of faces
+ (display (format "~w\n" (length Faces)) Fp)
+ (for-each (lambda (Face)
+ (define VList (e3d_face-vs Face))
+ (display (format "DEBUG:~w\n" VList))
+ (for-each (lambda (V)
+ ;; Index
+ (display (format "~w " V) Fp)
+ ) VList)
+ (display (format "\n") Fp)
+ ) Faces)
+ ) Objs)
+ '(ok)
+ ) :encoding 'utf8)
+ )
+
+(define (exporter *params* *extra-params*)
+ ;; e3d_file tuple is found in "content" of extra parameters, and the
+ ;; filename to export to is in filename.
+ ;;
+ (define Filename (list-ref (assoc "filename" *extra-params*) 1))
+ (define Content (list-ref (assoc "content" *extra-params*) 1))
+ (newline)
+ (export_fun '() Filename Content)
+ )
+
+(main-function exporter)
+
+type "scm"
+name ?__(1,"Example Exporter (.txt)")
+mode "export"
+params_title ?__(3,"Example Exporter Settings")
+params_init {
+ do %[1>$'subdivisions']
+}
+params_templates {
+ template export include_normals,include_uvs,include_colors
+}
+params_set {
+ export_param include_uvs %[bool(params/include_uvs)]
+ export_param subdivisions %[params/subdivisions]
+ export_param include_hard_edges 'true'
+ export_param script_texture_convert 'user'
+}
+extensions {
+ ext .txt ?__(5,"Text Mesh")
+}
+
+(main-function
+ (lambda (*params* *extra-params*)
+ (define filename
+ (list-ref
+ (assoc "filename" *extra-params*) 1))
+
+ ;;
+ ;; ...
+ ;;
+
+ ;; Return an e3d_file in a variable called e3df
+ (list 'ok e3df)
+ ))
+
(list 'ok (make-e3d_file `(objs ,(list Obj))))
+(use srfi-1)
+(use srfi-13) ; For string-tokenize
+
+(define (read-for-each Fp F)
+ (define NumVals (string->number (read-line Fp))) ; Number of values
+ (let loop ((I 0) (Vals (list)))
+ (if (< I NumVals)
+ (let ((Ret (F)))
+ (loop (+ I 1) (cons Ret Vals))
+ )
+ (reverse Vals))
+ )
+ )
+
+(define (import_fun Attr Filename)
+ (call-with-input-file Filename (lambda (Fp)
+ ; Read each object
+ (define Objs (read-for-each Fp
+ (lambda ()
+ (define ObjName (read-line Fp))
+ ; Read each vertex
+ (define Vs (read-for-each Fp
+ (lambda ()
+ (define Vtx0 (string-tokenize (read-line Fp)))
+ ; Vertex coordinate
+ (define Vtx (map exact->inexact (map string->number Vtx0)))
+ (list->vector Vtx))))
+ ; Read each face
+ (define Faces (read-for-each Fp
+ (lambda ()
+ ; Vertex indices
+ (define VList0 (string-tokenize (read-line Fp)))
+ (define VList (map string->number VList0))
+ (make-e3d_face
+ `(vs ,VList)
+ `(vc ,(list))
+ `(tx ,(list))
+ `(ns ,(list))
+ )
+ )))
+ (define Mesh (make-e3d_mesh
+ `(type polygon)
+ `(vs ,Vs)
+ `(fs ,Faces)
+ `(vc ,(list))
+ `(tx ,(list))
+ `(ns ,(list))
+ `(he ,(list))
+ ))
+ (make-e3d_object `(name ,ObjName) `(obj ,Mesh))
+ )))
+ (list 'ok (make-e3d_file `(objs ,Objs)))
+ ) :encoding 'utf8)
+ )
+
+(define (importer *params* *extra-params*)
+ ;; the filename to import from is in "filename" of extra parameters.
+ ;;
+ (define Filename (list-ref (assoc "filename" *extra-params*) 1))
+ (import_fun '() Filename)
+ )
+
+(main-function importer)
+
+type "scm"
+name ?__(1,"Example Importer (.txt)")
+mode "import"
+params_title ?__(3,"Example Importer Settings")
+params_templates {
+ template import
+}
+params_set {
+ import_param script_texture_convert 'auto'
+}
+extensions {
+ ext .txt ?__(5,"Text Mesh")
+}
+.wscr File
+
+For your script to be able to appear in the script chooser dialog, you will need to make a .wscr file with the same base name as your main Scheme script file. For example, if your script file is example.scm, your wscr file should be named example.wscr. The name that appears in the script chooser is the name specified in the .wscr file.
+
+Initial Bootstrap Script
+
+A bootstrap script that comes with the script plugin is first launched which then defines some basic functions, sometimes adds include paths, and gets from stdin the actual script being invoked as well as parameters that goes with it.
+
+Parameters that are passed in
+
+When a script is invoked, parameters from the dialog box are passed in, other parameters are also passed in depending on the type of script.
+
+Returning values from the script
+
+Scripts write to stdout their response before exiting.
+
+ (list 'ok '(new_shape ... ))
Calling functions in Wings3D from a script
+
+Scripts can communicate with the plugin by setting temporary variables and using queries to call functions and get the return value. Temporary variables makes it easier to input elaborate data structures as arguments by referencing them in the query.
+
+
+Set value to variable:
+
+
+ (wings-set-variable! "var1" '(1 2 3 4))
+
'ok
+ (wings-get-variable "var1")
+
'(1 2 3 4)
+ (wings-query "lists:reverse(<$'var1')")
+
'(4 3 2 1)
Calling We functions
+
+Most We functions are already wrapped into a defined function, and are covered in the we function reference.
+
+Other functions can be called with
+ (wings-we! Module FunName . Args)
+ (wings-we Module FunName . Args)
+
+
+Long Running Processes
+
+If your script runs for a long time, you want to use the long-running-process function. The long-running-process function continues your script processing in another thread, while sending back keep-alive messages to Wings3D so the program knows that the script has not timed out.
+
+
+(display "Started")(newline)
+(long-running-process
+ (lambda ()
+ (let loop ((N 100000000))
+ (if (> N 0)
+ (loop (- N 1))
+ 'ok))
+ ))
+(display "Done")(newline)
+
+(main-function
+ (lambda (*params* *extra-params*)
+ (list 'new_shape "MyShape"
+ '(
+ (0 1 3 2)
+ (6 7 5 4)
+ (1 0 4 5)
+ (2 3 7 6)
+ (0 2 6 4)
+ (3 1 5 7)
+ ) '(
+ #(-2.0 0.5 -2.0)
+ #(-2.0 0.5 2.0)
+ #(2.0 0.5 -2.0)
+ #(2.0 0.5 2.0)
+ #(-2.0 -0.5 -2.0)
+ #(-2.0 -0.5 2.0)
+ #(2.0 -0.5 -2.0)
+ #(2.0 -0.5 2.0)
+ ))
+ ))
+
+type "scm"
+name ?__(1,"Example New Shape")
+params_title ?__(3,"Example New Shape")
+params {
+param "Unused" 0.0
+}
+
+
+The .wscr and .scm file should have the same name before the extension (script.scm and script.wscr).
+
+To use parameters with the script, such as shifting the points by an adjustable value:
+
+
+(main-function
+ (lambda (*params* *extra-params*)
+ (define xshift (list-ref *params* 0))
+ (define yshift (list-ref *params* 1))
+ (define zshift (list-ref *params* 2))
+ (list 'new_shape "MyShape"
+ '(
+ (0 1 3 2)
+ (6 7 5 4)
+ (1 0 4 5)
+ (2 3 7 6)
+ (0 2 6 4)
+ (3 1 5 7)
+ ) '(
+ (vector (+ val -2.0) (+ yshift 0.5) (+ zshift -2.0))
+ (vector (+ val -2.0) (+ yshift 0.5) (+ zshift 2.0))
+ (vector (+ val 2.0) (+ yshift 0.5) (+ zshift -2.0))
+ (vector (+ val 2.0) (+ yshift 0.5) (+ zshift 2.0))
+ (vector (+ val -2.0) (+ yshift -0.5) (+ zshift -2.0))
+ (vector (+ val -2.0) (+ yshift -0.5) (+ zshift 2.0))
+ (vector (+ val 2.0) (+ yshift -0.5) (+ zshift -2.0))
+ (vector (+ val 2.0) (+ yshift -0.5) (+ zshift 2.0))
+ ))
+ ))
+
+type "scm"
+name ?__(1,"Example New Shape")
+params_title ?__(3,"Example New Shape")
+params {
+param "X" 0.0
+param "Y" 0.0
+param "Z" 0.0
+}
+
+
+
+
+Another way to create a new shape where you might want to add colors, UVs, materials and hard edges is to make a new shape using a e3d_object.
+
+
+(main-function
+ (lambda (*params* *extra-params*)
+ (define Fs ...) ; List of indices into vertice list
+ (define Vs ...) ; Vertice list
+ (define Efs (map (lambda (Indices)
+ (make-e3d_face `(vs ,Indices))) Fs))
+ (define Mesh (make-e3d_mesh
+ `(type polygon)
+ `(vs ,Vs)
+ `(fs ,Efs)
+ ))
+ (define Obj (make-e3d_object `(obj ,Mesh)))
+ (define Mat '())
+ (list 'new_shape "MyShape" Obj Mat)
+ ))
+
+
+
+
diff --git a/plugins_src/scripting/docs/en/wscr/directives/adv_param.txt b/plugins_src/scripting/docs/en/wscr/directives/adv_param.txt
new file mode 100644
index 000000000..2c87120b4
--- /dev/null
+++ b/plugins_src/scripting/docs/en/wscr/directives/adv_param.txt
@@ -0,0 +1,29 @@
+adv_param Directive
+
+adv_params begin
+ {vframe, [
+ {hframe,[
+ {label,?__(3,"Path:")},
+ {text,"testing2",[{key,path}]}]},
+ panel,
+ separator,
+ {?__(2,"Enable"), 'true', [{key,enable}]}
+ ]}
+end.
+
+browse "Click to browse" "filename.txt"
+
+checkbox "Enabled" 'true'
+
+command_changes "points"
+
+command_inputs "points,faces"
+
+desc ?__(2,"This script does something")
+
+export_param "subdivisions" %[params/subdivisions]
+
+extensions {
+ ext ".tres" ?__(5,"Godot Mesh Library")
+}
+
+extra_file "icon" {
+ title "Choose small image"
+ extensions {
+ ...
+ }
+}
+
+hradio "Color" 'blue' {
+ item "Red" 'red'
+ item "Green" 'green'
+ item "Blue" 'blue'
+}
+
+import_param "script_texture_convert" 'auto'
+
+include "(%)_dialog.inclr"
+
+menu "Color" 'blue' {
+ item "Red" 'red'
+ item "Green" 'green'
+ item "Blue" 'blue'
+}
+
+mode "import"
+
+Kind of script mode
+-------------- ----
+New shapes (empty)
+Importers import
+Exporters export
+Commands command
+
+name ?__(1,"Raw Triangles (.raw)")
+
+param "Size" "2.0"
+
+params {
+ param "Size" "2.0"
+ ...
+}
+
+params_init {
+ do %[1>$'subdivisions']
+}
+
+params_preview 1
+
+params_set {
+ export_param "include_uvs" %[bool(params/include_uvs)]
+ ...
+}
+
+params_templates {
+ template "export" ""
+}
+
+params_title ?__(3,"Command Settings")
+
+script_param "test" "1"
+
+template "export" ""
+
+type "py"
+
+vradio "Color" 'blue' {
+ item "Red" 'red'
+ item "Green" 'green'
+ item "Blue" 'blue'
+}
+
+name ?__(1,"Color")
+
+{script,
+ [
+ {wscr,
+ [
+ {1,"Couleur"}
+ ]}
+ ]}.
+
+%% Syntax of conf file, comment lines start with %
+
+{<Name>, [
+ {wscr, <WSCRFile>},
+ {menu, [
+ {<MenuPath>, <Option>}
+ ]}
+]}.
+
+{strings, [
+ {plugin, <Name>},
+ {<LangCode>, [
+ {{plugin,<MenuPathItem>}, <ActualName>},
+ {{menu,<MenuPathItem>}, <ActualName>},
+ ...
+ {{info,<MenuPathItem>}, <Text>}
+ ]}
+]}.
+
+%% Example plugin script .conf file:
+
+{"com.example.my.plugin.1", [
+ {wscr, "my-plugin.wscr"},
+ {menu, [
+ {[tools, newsubmenu, newnewsubmenu, myplugin], []}
+ ]}
+]}.
+
+{strings, [
+ {plugin, "com.example.my.plugin.1"},
+ {"en", [
+ {{plugin,name}, "My Plugin"},
+ {{menu,newsubmenu}, "New Submenu"},
+ {{menu,newnewsubmenu}, "New new Submenu"},
+ {{menu,myplugin}, "My Plugin"},
+ {{info,myplugin}, "My Plugin menu tooltip"}
+ ]}
+]}.
+First Identifier
+
+The first identifier in the query can be an identifier such as st, params, a temporary variable retrieval, a function call, a tuple/list constructor or a literal such as 1, 'atom' or "string".
+
+
+Atoms
+
+Atoms must be enclosed in single quotes, words without single quotes are not automatically made into atoms.
+
+e.g.
+
+
+ 'triangulated'
+
Strings
+
+Strings are enclosed in double quotes.
+
+e.g.
+
+
+ "Sample text"
+
Numbers
+
+Integers and floating point numbers can be used in the query.
+
+e.g.
+
+
+ 1
+ 1.2
+
Dot Notation
+
+
+ variable.shapes
+
+ st.shapes
+
Associative List Path
+
+
+ variable/key
+
+ params/include_uvs
+
Tuple by index
+
+
+ variable{0}
+
+ tuple(1,2,3,4){2}
+List by index
+
+
+ variable[0]
+
+ list(1,2,3,4)[1]
+
Store to
+
+
+ >$'variable'
+
+ params/include_uvs>$'include_uvs'
+
Get from
+
+
+ <$'variable'
+
+ <$'settings'/group1/setting
+
Call function
+
+
+ module:function( ... )
+
+ lists:reverse(list(1,2,3,4))
+
List constructor
+
+
+ list(1,'two',3)
+
Tuple constructor
+
+
+ tuple(1,2,'three')
+
Boolean Value
+
+
+ bool(1)
+
Integer Value
+
+
+ int("1")
+Float Value
+
+
+ float("1.0")
+Ok Test
+
+
+ ok_test(orddict:find(key, $<'variable'), "not found")
+
Value Test
+
+
+ value_test('value', gb_trees:lookup(key, $<'variable'), "not found")
+Conditional If
+
+
+ if(bool(<$'cond'), "on", "off")
+
+%% Syntax of config file, comment lines start with %
+
+{<Name>,[
+ {type,<Type>},
+ {path,<Paths>}
+]}.
+
+%% Example script folder .conf file:
+
+{"com.example.wings-scripts-1",[
+ {type,[shape]},
+ {path,["a1/","a2/"]}
+]}.
+
+{"com.example.scripts.2",[
+ {type,[face,body]},
+ {path,["a/"]}
+]}.
+