Create effect should use the correct resource structure

Author: einarf

TODO.md

@@ -1,9 +1,10 @@
 
 ## TODO
 
-- Split up README into several files
-- Properly verify all settings
 - Write documentation (readthedocs)
+  - Effects
+  - OpenGL stuff
+- Properly verify all settings
 - Make EffectControllers
   - SingleEffectController
   - TrackSystemEffectController
@@ -27,4 +28,4 @@ Generic Data:
   - FBOs
   - Textures
 - Settings entry for key bindings
-- Look into using freetype
+- Look into using freetype or some kind of fonts

demosys/core/management/commands/createeffect.py

@@ -23,26 +23,33 @@ def handle(self, *args, **options):
             return
 
         os.mkdir(name)
-        os.mkdir(os.path.join(name, 'textures'))
-        os.mkdir(os.path.join(name, 'shaders'))
+        os.makedirs(os.path.join(name, 'textures', name))
+        os.makedirs(os.path.join(name, 'shaders', name))
 
         # Create effect.py
         with open(os.path.join(name, 'effect.py'), 'w') as fd:
-            fd.write(default_effect())
+            fd.write(default_effect(name))
 
         # Create default.glsl
-        with open(os.path.join(name, 'shaders', 'default.glsl'), 'w') as fd:
+        with open(os.path.join(name, 'shaders', name, 'default.glsl'), 'w') as fd:
             fd.write(default_shader())
 
 
-def default_effect():
+def default_effect(name):
     file_path = os.path.join(root_path(), 'effects/default/effect.py')
-    return open(file_path, 'r').read()
+    with open(file_path, 'r') as fd:
+        data = fd.read()
+
+    data = data.replace('"default/default.glsl"', '"{}/default.glsl"'.format(name))
+    return data
 
 
 def default_shader():
-    file_path = os.path.join(root_path(), 'effects/default/shaders/default.glsl')
-    return open(file_path, 'r').read()
+    file_path = os.path.join(root_path(), 'effects/default/shaders/default/default.glsl')
+    with open(file_path, 'r') as fd:
+        data = fd.read()
+
+    return data
 
 
 def root_path():

demosys/effects/default/effect.py

@@ -1,13 +1,13 @@
 from demosys.effects import effect
 from demosys.opengl import geometry
 from OpenGL import GL
-from pyrr import matrix44
+# from pyrr import matrix44
 
 
 class DefaultEffect(effect.Effect):
     """Generated default efffect"""
     def __init__(self):
-        self.shader = self.get_shader("default.glsl")
+        self.shader = self.get_shader("default/default.glsl")
         self.cube = geometry.cube(4.0, 4.0, 4.0)
 
     @effect.bind_target
@@ -16,7 +16,7 @@ def draw(self, time, frametime, target):
 
         # Rotate and translate
         m_mv = self.create_transformation(rotation=(time * 1.2, time * 2.1, time * 0.25),
-                                          translation=(0.0, 0.0, -6.0))
+                                          translation=(0.0, 0.0, -8.0))
 
         # Apply the rotation and translation from the system camera
         # m_mv = matrix44.multiply(m_mv, self.sys_camera.view_matrix)

demosys/effects/default/shaders/default.glsl renamed to demosys/effects/default/shaders/default/default.glsl

@@ -102,8 +102,10 @@ We should now have the folloing structure:
     ├── cube
     │   ├── effect.py
     │   ├── shaders
-    │   │   └── default.glsl
+    │   │   └── cube
+    │   │       └── default.glsl
     │   └── textures
+    │       └── cube
     └── settings.py
     manage.py
 
@@ -112,6 +114,12 @@ The ``cube`` directory is a template for an effect:
 - A local ``shaders`` directory for glsl shaders specific to the effect
 - A local ``textures`` directory for texture files specific to the effect
 
+Notice that the ``shaders`` and ``textures`` directory also has a sub-folder with the same name
+as the effect. This is because these directories are added to a global virtual directory
+and the only way to make these resources unique is to put it in a directory that is *hopefully* unique.
+
+This can of course be used in creative ways to also override resources on purpose.
+
 For the effect to be recognized by the system we need to add it ``EFFECTS`` in
 ``settings.py``.
 

docs/source/quickstart.rst

@@ -2,7 +2,7 @@
 
 setup(
     name="demosys-py",
-    version="0.3.5",
+    version="0.3.6",
     description="Modern OpenGL 4.1+ Prototype Framework inspired by Django",
     long_description=open('README.rst').read(),
     url="https://github.com/Contraz/demosys-py",