Merge pull request #6 from NikSudan/version-2

Version 2

README.md

@@ -1,96 +1,49 @@
-<p align="center"><img width="200" src="http://i.imgur.com/R6cqqDc.png"></p>
+<p align="center"><img width="150" src="http://i.imgur.com/R6cqqDc.png"></p>
 <h1 align="center">prettylight</h1>
-<p align="center">Pretty lights for Game Maker</p>
-
-- [Screenshots](#screenshots)
-- [Credits](#credits)
-- [Prerequisites](#prerequisites)
-- [Setting Up](#setting-up)
-- [Drawing Lights](#drawing-lights)
-  - [Ambient Lighting](#ambient-lighting)
-- [Light Sprites](#light-sprites)
-- [Extra Effects](#extra-effects)
-  - [Vivid Lighting](#vivid-lighting)
-  - [Ambient Blurring](#ambient-blurring)
+<p align="center">Pretty lights for GameMaker</p>
 
-## Screenshots
-
-![Tercon Major](http://i.imgur.com/jMfCAMY.png)
+<p align="center"><i>Version 2.0</i></p>
 
-![Protocol](http://i.imgur.com/NN0c4ex.png)
+prettylight is a powerful lighting engine for use with GameMaker: Studio. It makes use of surfaces and shaders to give you a simple to use yet optimal solution to your problems in need of lighting up!
 
-![Ahriman's Treasure](http://i.imgur.com/YEpCTx5.png)
+## Screenshots
 
-![Skolgbor](http://i.imgur.com/QEYSaAh.png)
+![](http://i.imgur.com/8lQR4pk.png)
+![](http://i.imgur.com/820eNjo.png)
 
 ## Credits
 
-prettylight is a simplistic and powerful lighting engine for use with GameMaker: Studio. It features code by FatalSleep and xygthop3, who are amazing coders and I can't thank them enough for the resources they create.
-
-Please give credit to **Nik Sudan, FatalSleep and xygthop3** if you decide to use it in your projects!
-
-## Prerequisites
-
-prettylight requires a few things in your project in order for it to function.
-
-- A view
-- A light sprite called ```sprLight```
-- A light controller object
-- At least one light object
-
-prettylight comes with a prebuilt light controller and parent object, but you can implement their functionality into other objects.
-
-## Setting Up
-
-The lights are controlled with the light controller object. This should have a pretty low depth so it runs before other objects. The controller object needs to run 4 functions:
-
-- ``` lights_init( shaders? , view_id ) ``` - this sets up the lighting system, call this in a **creation or trigger event**
-- ``` lights_step() ``` - this processes the lighting system, call this in a **step event**
-- ``` lights_draw() ``` - this controls the drawing for the lighting system, call this in the **draw gui event**
-- ``` lights_finish() ``` - this ends the lighting system, call this in the **room/game end event**
-
-For the function ``` lights_init() ```,  "shaders?" defines whether or not to apply shaders to the lighting system and "view_id" is the id 0-15 of whichever view you wish to enable lighting on.
-
-## Drawing Lights
-
-In order to draw lights you need to register light objects. You can do this with the function ``` lights_add( obj1, obj2, obj3, ... ) ```. Typical usage would be registering a light parent object using this.
-
-Call the ``` light_set() ``` script to set up your light object. Just make sure that all the properties are set, otherwise an error will be thrown. There are 5 additional functions you can use to customise certain features:
-
-- ``` light_set_alpha( value ) ``` - sets the light's alpha
-- ``` light_set_color( colour ) ``` - sets the light's colour
-- ``` light_set_scale( xscale, yscale ) ``` - sets the light's scale
-- ``` light_set_spite( sprite, index ) ``` - sets the light's sprite
-- ``` light_set_offset( xoffset, yoffset ) ``` - sets the light's x,y offset
+Lots of lighting help by **FatalSleep**, gaussian blur shaders written by **xygthop3**.
 
-#### Ambient Lighting
+## Usage
 
-In the light controller you can specify ambient lighting. This will get displayed in areas that aren't lit up. To modify this, use the function ``` lights_set_ambience( colour, alpha ) ```. I've specified one I normally use in the controller that's included - it produces a nice brooding blue overlay.
+### Setting Up
 
-## Light Sprites
+prettylight doesn't need much to work. It needs the appropriate scripts and shaders to run properly, that's all.
 
-In prettylight, lights rely on sprites. A basic radial one is included, but you can introduce more interesting patterns with ease. Lights need to be in a certain way for it to function properly:
+First things first, you'll want to initialise the system within your control object. Simply call `pl_init()` in your **create event** to set up the engine, and preferably add all light object parents within the `pl_add()` method. For example, all your light sources would be children of an object called `objLight` - you'd then add that parent object to the light objects list in order for it to work. This is so the engine knows which objects it should mess with when lighting things up!
 
-- Lights should only use white
-- A white area indicates a fully lit section
-- A transparent area indicates a non-lit section
+You'll need to process the engine in a **step event** of your choosing (**begin step** is preferred) using `pl_update()`, draw the lights in the **draw event** with `pl_draw()`, and end the system in the **room end**/**game end** event using `pl_end()`.
 
-The one sprite that's included with the package, ```sprLight```, is required for the package to work, so don't modify it!
+You'll also need a view to draw the lights. prettylight is currently set to process in the view with id 0 (the default one).
 
-## Extra Effects
+### Making Lights
 
-Two extra effects are enabled by default, but you can turn these off.
+In order for something to light up, make sure it or it's parent is added to the light object list using `pl_add(obj1, obj2, ...)` as stated above. Then simply call `pl_light_init(radius, colour, alpha)` in your create event. You may modify your light using the available methods, but please note you can't specify a radius larger than the one you initially put in.
 
-#### Vivid Lighting
+### Customisation
 
-This amplifies lights in general and really brings out the colour used. This isn't very intensive but with lots of lights it might slow down the game a little bit. 
+You may toggle certain options using the provided scripts:
 
-- ``` lights_set_vivid( active? ) ``` - whether to enable vivid lighting
+- `pl_set_vivid(active?)` - toggles vivid lighting (uses additional surface)
+- `pl_set_blurring(active?)` - toggles blurring (uses shaders)
+- `pl_option_set_ambience(color, brightness)` - make changes to the ambience
+- `pl_option_set_blur(amount, alpha)` - make changes to the blur
 
-#### Ambient Blurring
+## What's Next?
 
-This makes use of xygthop3's gaussian blur shaders, and it makes everything look all bloomy and fuzzy and nice. This can be very intensive and might not work for older computers, so be sure to make it some sort of option if you decide to use it. If you turn off shaders in ``` lights_init() ``` blurring will not work. You can configure this with three functions:
+prettylight is currently maintained primarily by [Nik Sudan](http://github.com/niksudan), but I'm more than happy to approve merge requests that help the project develop even further! Future features that would be cool include:
 
-- ``` lights_set_blur( active? ) ``` - whether to enable ambient blurring
-- ``` lights_set_blur_alpha( alpha ) ``` - the alpha overlay (1 = fully blurred, 0 = no blur)
-- ``` lights_set_blur_amount( amount ) ``` - the blur amount (the bigger the number, the more intensive it is)
+- Shadow casters (pretty much coded, needs optimising though!)
+- Ambient blur (was in version 1, would be nice to have a comeback!)
+- Light styles (cartoony, pixelly, etc.)

prettylight.gmx/Configs/Default.config.gmx

@@ -64,6 +64,7 @@
     <option_audioGroupCount>1</option_audioGroupCount>
     <option_author></option_author>
     <option_backimage>nil</option_backimage>
+    <option_borderless>false</option_borderless>
     <option_changed>false</option_changed>
     <option_changeresolution>false</option_changeresolution>
     <option_closeesc>true</option_closeesc>
@@ -89,6 +90,7 @@
     <option_html5_advertising_type>Supersonic Ads</option_html5_advertising_type>
     <option_html5_allow_fullscreen>true</option_html5_allow_fullscreen>
     <option_html5_alwaysreload>false</option_html5_alwaysreload>
+    <option_html5_browser_title>Created with GameMaker:Studio</option_html5_browser_title>
     <option_html5_centergame>false</option_html5_centergame>
     <option_html5_flurry_enable>false</option_html5_flurry_enable>
     <option_html5_flurry_id></option_html5_flurry_id>
@@ -101,6 +103,7 @@
     <option_html5_interpolate>true</option_html5_interpolate>
     <option_html5_jsprepend></option_html5_jsprepend>
     <option_html5_loadingbar>-1</option_html5_loadingbar>
+    <option_html5_localrunalert>true</option_html5_localrunalert>
     <option_html5_outputdebugtoconsole>false</option_html5_outputdebugtoconsole>
     <option_html5_outputname>index.html</option_html5_outputname>
     <option_html5_scale>-1</option_html5_scale>

prettylight.gmx/background/bgExample.background.gmx

@@ -0,0 +1,19 @@
+<!--This Document is generated by GameMaker, if you edit it by hand then you do so at your own risk!-->
+<background>
+  <istileset>0</istileset>
+  <tilewidth>16</tilewidth>
+  <tileheight>16</tileheight>
+  <tilexoff>0</tilexoff>
+  <tileyoff>0</tileyoff>
+  <tilehsep>0</tilehsep>
+  <tilevsep>0</tilevsep>
+  <HTile>-1</HTile>
+  <VTile>-1</VTile>
+  <TextureGroups>
+    <TextureGroup0>0</TextureGroup0>
+  </TextureGroups>
+  <For3D>0</For3D>
+  <width>64</width>
+  <height>64</height>
+  <data>images\bgExample.png</data>
+</background>

prettylight.gmx/objects/objLightControl.object.gmx → prettylight.gmx/objects/control.object.gmx

@@ -25,14 +25,10 @@
         <arguments>
           <argument>
             <kind>1</kind>
-            <string>/// Controller for lights
-lights_init( true , 0 );
+            <string>/// Start prettylight
 
-// To make non-lit up areas blue (ooo)
-lights_set_ambience( make_color_hsv(200, 125, 50), 0.5 );
-
-// Register light objects
-lights_add( objLight );
+pl_init();
+pl_add(objLight);
 </string>
           </argument>
         </arguments>
@@ -55,8 +51,9 @@ lights_add( objLight );
         <arguments>
           <argument>
             <kind>1</kind>
-            <string>/// Process light system
-lights_step();
+            <string>/// Process prettylight
+
+pl_update();
 </string>
           </argument>
         </arguments>
@@ -79,14 +76,15 @@ lights_step();
         <arguments>
           <argument>
             <kind>1</kind>
-            <string>/// End light system
-lights_finish();
+            <string>/// End prettylight
+
+pl_end();
 </string>
           </argument>
         </arguments>
       </action>
     </event>
-    <event eventtype="8" enumb="64">
+    <event eventtype="8" enumb="0">
       <action>
         <libid>1</libid>
         <id>603</id>
@@ -103,8 +101,9 @@ lights_finish();
         <arguments>
           <argument>
             <kind>1</kind>
-            <string>/// Draw lights
-lights_draw();
+            <string>/// Draw prettylight
+
+pl_draw();
 </string>
           </argument>
         </arguments>

prettylight.gmx/objects/objExample.object.gmx

@@ -0,0 +1,62 @@
+<!--This Document is generated by GameMaker, if you edit it by hand then you do so at your own risk!-->
+<object>
+  <spriteName>sprExample</spriteName>
+  <solid>0</solid>
+  <visible>-1</visible>
+  <depth>0</depth>
+  <persistent>0</persistent>
+  <parentName>&lt;undefined&gt;</parentName>
+  <maskName>&lt;undefined&gt;</maskName>
+  <events>
+    <event eventtype="3" enumb="0">
+      <action>
+        <libid>1</libid>
+        <id>603</id>
+        <kind>7</kind>
+        <userelative>0</userelative>
+        <isquestion>0</isquestion>
+        <useapplyto>-1</useapplyto>
+        <exetype>2</exetype>
+        <functionname></functionname>
+        <codestring></codestring>
+        <whoName>self</whoName>
+        <relative>0</relative>
+        <isnot>0</isnot>
+        <arguments>
+          <argument>
+            <kind>1</kind>
+            <string>/// Example object that moves around
+
+if (keyboard_check(vk_left)) {
+    x -= 13;
+} else if (keyboard_check(vk_right)) {
+    x += 13;
+}
+
+if (keyboard_check(vk_up)) {
+    y -= 13;
+} else if (keyboard_check(vk_down)) {
+    y += 13;
+}
+</string>
+          </argument>
+        </arguments>
+      </action>
+    </event>
+  </events>
+  <PhysicsObject>0</PhysicsObject>
+  <PhysicsObjectSensor>0</PhysicsObjectSensor>
+  <PhysicsObjectShape>0</PhysicsObjectShape>
+  <PhysicsObjectDensity>0.5</PhysicsObjectDensity>
+  <PhysicsObjectRestitution>0.100000001490116</PhysicsObjectRestitution>
+  <PhysicsObjectGroup>0</PhysicsObjectGroup>
+  <PhysicsObjectLinearDamping>0.100000001490116</PhysicsObjectLinearDamping>
+  <PhysicsObjectAngularDamping>0.100000001490116</PhysicsObjectAngularDamping>
+  <PhysicsObjectFriction>0.200000002980232</PhysicsObjectFriction>
+  <PhysicsObjectAwake>-1</PhysicsObjectAwake>
+  <PhysicsObjectKinematic>0</PhysicsObjectKinematic>
+  <PhysicsShapePoints>
+    <point>166,202</point>
+    <point>202,202</point>
+  </PhysicsShapePoints>
+</object>

prettylight.gmx/objects/objLight.object.gmx

@@ -25,19 +25,9 @@
         <arguments>
           <argument>
             <kind>1</kind>
-            <string>/// Light object
+            <string>/// Example light object
 
-/**
- * This object represents an object that emits light
- * Assign this to any object as it's parent to register the object.
- *
- * You can then configure the light properties by either
- * - Configuring all possible options with light_set()
- * - Configuring commonly used options with various light_set functions
-*/
-
-// The default light settings
-light_set( sprLight, 0, 0, 0, 1, 1, 0, c_white, 1 );
+pl_light_init(90, make_color_rgb(252, 150, 55), 1);
 </string>
           </argument>
         </arguments>

prettylight.gmx/objects/objLightBig.object.gmx

@@ -0,0 +1,49 @@
+<!--This Document is generated by GameMaker, if you edit it by hand then you do so at your own risk!-->
+<object>
+  <spriteName>&lt;undefined&gt;</spriteName>
+  <solid>0</solid>
+  <visible>-1</visible>
+  <depth>0</depth>
+  <persistent>0</persistent>
+  <parentName>objLight</parentName>
+  <maskName>&lt;undefined&gt;</maskName>
+  <events>
+    <event eventtype="0" enumb="0">
+      <action>
+        <libid>1</libid>
+        <id>603</id>
+        <kind>7</kind>
+        <userelative>0</userelative>
+        <isquestion>0</isquestion>
+        <useapplyto>-1</useapplyto>
+        <exetype>2</exetype>
+        <functionname></functionname>
+        <codestring></codestring>
+        <whoName>self</whoName>
+        <relative>0</relative>
+        <isnot>0</isnot>
+        <arguments>
+          <argument>
+            <kind>1</kind>
+            <string>/// Example big light object
+
+pl_light_init(180, make_color_rgb(252, 150, 55), 1);
+</string>
+          </argument>
+        </arguments>
+      </action>
+    </event>
+  </events>
+  <PhysicsObject>0</PhysicsObject>
+  <PhysicsObjectSensor>0</PhysicsObjectSensor>
+  <PhysicsObjectShape>0</PhysicsObjectShape>
+  <PhysicsObjectDensity>0.5</PhysicsObjectDensity>
+  <PhysicsObjectRestitution>0.100000001490116</PhysicsObjectRestitution>
+  <PhysicsObjectGroup>0</PhysicsObjectGroup>
+  <PhysicsObjectLinearDamping>0.100000001490116</PhysicsObjectLinearDamping>
+  <PhysicsObjectAngularDamping>0.100000001490116</PhysicsObjectAngularDamping>
+  <PhysicsObjectFriction>0.200000002980232</PhysicsObjectFriction>
+  <PhysicsObjectAwake>-1</PhysicsObjectAwake>
+  <PhysicsObjectKinematic>0</PhysicsObjectKinematic>
+  <PhysicsShapePoints/>
+</object>