Skip to content

Commit 2a24014

Browse files
committed
Docs: Specify effect with runeffect
1 parent a8ec068 commit 2a24014

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/user_guide/effects.rst

+11
Original file line numberDiff line numberDiff line change
@@ -165,12 +165,23 @@ Effect packages can be run by using the ``runeffect`` command::
165165

166166
python manage.py runeffect <python.path.to.package>
167167

168+
# Example
169+
python manage.py runeffect examples.cubes
170+
168171
This will currently look for the first effect class with the ``runnable`` attribute set to ``True``,
169172
make an instance of that effect and call its ``draw`` method every frame. The effect package
170173
dependencies are also handled. (All handled by ``DefaultProject`` class)
171174

172175
The runnable effect is resposible for instantiating other effects it depends on and call them
173176
directly.
174177

178+
Optionally you can also specify the exact effect to run in the effect package
179+
by adding the class name to the path::
180+
181+
python manage.py runeffect <python.path.to.package>.<effect class name>
182+
183+
# Example
184+
python manage.py runeffect examples.cubes.Cubes
185+
175186
If you need a more complex setup where multiple runnable effects are involved, you need
176187
to create a proper project config using ``project.py`` and instead use the ``run`` command.

0 commit comments

Comments
 (0)