├── lib ├── gajse-protagonist.js ├── gajse-protogoro.js ├── gajse-character.js ├── gajse-action.js ├── gajse-light.js ├── gajse-text.js ├── gajse-item.js ├── gajse-input.js ├── gajse-mesh-actions.js ├── gajse-cutscene.js ├── gajse-collision.js ├── gajse-slim-storage.js ├── gajse-hud.js ├── gajse-loader.js ├── gajse-version.js ├── gajse-api.js ├── gajse-audio.js ├── gajse-msg.js ├── gajse-loop.js └── gajse-storage.js ├── gajse.js ├── yuidoc.json ├── .travis.yml ├── .gitignore ├── appveyor.yml ├── package.json ├── Gruntfile.js ├── README.md ├── gajse.svg └── LICENSE /lib/gajse-protagonist.js: -------------------------------------------------------------------------------- 1 | var THREE=require("three"); 2 | 3 | exports.Protagoro=function(){ 4 | THREE.Mesh.call(this); 5 | } 6 | Protagoro.prototype=Object.create(THREE.Mesh.prototype); 7 | -------------------------------------------------------------------------------- /lib/gajse-protogoro.js: -------------------------------------------------------------------------------- 1 | var THREE=require("three"); 2 | 3 | var Protogoro=exports.Protogoro=function(nameProtogoro){ 4 | THREE.Mesh.call(this); 5 | this.name=name; 6 | } 7 | Protogoro.prototype=Object.create(THREE.Mesh.prototype); 8 | -------------------------------------------------------------------------------- /gajse.js: -------------------------------------------------------------------------------- 1 | var version=require("./lib/gajse-version"); 2 | var loader=require("./lib/gajse-loader"); 3 | 4 | console.log("GAJSE - "+version.showVersion()); 5 | 6 | window.addEventListener("load",function(){ 7 | loader.loadConfiguration(function(data){ 8 | loader.loadEnvironment(data); 9 | }); 10 | }); 11 | -------------------------------------------------------------------------------- /yuidoc.json: -------------------------------------------------------------------------------- 1 | { 2 | "name" : "GAJSE", 3 | "description" : "GAJSE is a JavaScript library that allows you to create Graphic Adventures", 4 | "version" : "0.0.5", 5 | "url" : "http://adrianarroyocalle.github.io/gajse", 6 | "logo" : "gajse.svg", 7 | "options" : { 8 | "linkNatives" : "true", 9 | "outdir" : "docs" 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /lib/gajse-character.js: -------------------------------------------------------------------------------- 1 | /** 2 | * The GAJSE character classes 3 | * @constructor 4 | */ 5 | var msg=require("./gajse-msg"); 6 | 7 | exports.Character=function(name,color){ 8 | this.name=name; 9 | this.color=color; 10 | this.mesh=""; 11 | this.getCharacterTalker=function(){ 12 | 13 | return function(str){ 14 | /* USE MSG MODULE */ 15 | //console.log(this.name + " SAYS "+str); 16 | msg.say(str,this.color); 17 | }.bind(this); 18 | }.bind(this); 19 | return this; 20 | } 21 | -------------------------------------------------------------------------------- /lib/gajse-action.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Actions are made by Characters 3 | * @module gajse-action 4 | * @static 5 | * @constructor 6 | * @since 0.1.0 7 | */ 8 | 9 | exports.Action=function(actionName){ 10 | 11 | } 12 | exports.Action.prototype.addMovement=function(position,time){ 13 | 14 | } 15 | 16 | exports.Action.prototype.giveItem=function(item){ 17 | 18 | } 19 | 20 | exports.Action.prototype.quit=function(){ 21 | 22 | } 23 | 24 | exports.Action.prototype.say=function(){ 25 | 26 | } 27 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | os: 3 | - linux 4 | - osx 5 | before_install: 6 | - npm install -g grunt-cli 7 | node_js: 8 | - '0.11' 9 | - '0.10' 10 | - iojs 11 | deploy: 12 | provider: npm 13 | email: adrian.arroyocalle@gmail.com 14 | api_key: 15 | secure: E4qwjqfZu0Np780KOgMII68PMZTBTr/WZZn0FWqUBYXao1RurSkEvvA6oif3ppXgZnqiecEQSwHnqytUTNuOkFJrFSMF52Z3qkSZ8CHnpFxqwPdm8MFznAnshutVlb3e0lHWHh9w8FXWJzqFcOJz5akt7ib2fHz3MshZNpyfbbA= 16 | on: 17 | tags: true 18 | repo: AdrianArroyoCalle/gajse 19 | -------------------------------------------------------------------------------- /lib/gajse-light.js: -------------------------------------------------------------------------------- 1 | /* 2 | * gajse-light.js | The light system for GAJSE scenes using Three.js 3 | */ 4 | var THREE=require("three"); 5 | 6 | exports.Light=function(type,color,position,options){ 7 | var light; 8 | if(type=="ambient") 9 | light=new THREE.AmbientLight(color); 10 | else if(type=="directional") 11 | light=new THREE.DirectionalLight(color,options.intensity); 12 | else if(type=="point") 13 | light=new THREE.PointLight(color,options.intensity,options.distance); 14 | var event=new CustomEvent("GAJSE_PushMesh",{"detail": {"position": position, "mesh": light}}); 15 | document.dispatchEvent(event); 16 | } 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # Compiled binary addons (http://nodejs.org/api/addons.html) 20 | build/Release 21 | 22 | # Dependency directory 23 | # Deployed apps should consider commenting this line out: 24 | # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git 25 | node_modules 26 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | # http://www.appveyor.com/docs/appveyor-yml 2 | # Fix line endings in Windows. (runs before repo cloning) 3 | os: Windows Server 2012 4 | 5 | init: 6 | - git config --global core.autocrlf input 7 | 8 | environment: 9 | matrix: 10 | - nodejs_version: "0.8" 11 | - nodejs_version: "0.10" 12 | - nodejs_version: "0.11" 13 | matrix: 14 | allow_failures: 15 | - nodejs_version: "0.11" 16 | - nodejs_version: "0.8" 17 | install: 18 | - ps: Update-NodeJsInstallation (Get-NodeJsLatestBuild $env:nodejs_version) 19 | - npm install 20 | - npm install -g grunt-cli 21 | test_script: 22 | - node --version 23 | - npm --version 24 | - grunt 25 | 26 | build: off 27 | version: "{build}" 28 | -------------------------------------------------------------------------------- /lib/gajse-text.js: -------------------------------------------------------------------------------- 1 | /** 2 | * GAJSE Text module. It parses the GAJSE Text files for make decisions 3 | * @constructor 4 | * 5 | * @since 0.0.2 6 | * */ 7 | exports.Text=function(resource){ 8 | //var url=storage.getURLResourceAs(resource,"text/javascript"); 9 | //var script=document.createElement("script"); 10 | return this; 11 | } 12 | exports.ScriptedText=function(callback){ 13 | this.speak=function(){ 14 | callback(); 15 | } 16 | } 17 | exports.Answer=function(answer,scriptedText){ 18 | this.answer=answer; 19 | this.scriptedText=scriptedText; 20 | } 21 | exports.Question=function(options){ 22 | this.answers=options; 23 | this.ask=function(){ 24 | console.log("Current answers for the question"); 25 | options.forEach(function(answer){ 26 | //msg.say(answer.answer); 27 | console.log(answer.answer); 28 | }); 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /lib/gajse-item.js: -------------------------------------------------------------------------------- 1 | /* 2 | * gajse-item.js 3 | */ 4 | /** 5 | * An Item is a object that can interact with another items. It defines some methods. 6 | * @constructor 7 | * @param nam - The name of the item 8 | * @param descriptio - The description of the item when the user takes a look 9 | * @param im - A resource containing the image for the HUD 10 | * */ 11 | exports.Item=function Item(nam,descriptio,im) 12 | { 13 | var callbacks={ 14 | action: function(){}, 15 | thinking: function(){}, 16 | collect: function(){} 17 | }; 18 | var name=nam; 19 | var description=descriptio; 20 | var img=im; 21 | this.addActionCallback=function(cback){ 22 | callbacks.action=cback; 23 | }; 24 | this.addThinkingCallback=function(cback){ 25 | callbacks.thinking=cback; 26 | }; 27 | this.addCollectCallback=function(cback){ 28 | callbacks.collect=cback; 29 | }; 30 | this.setName=function(nam){ 31 | name=nam; 32 | }; 33 | this.setDescription=function(descriptio){ 34 | description=descriptio; 35 | }; 36 | this.setImage=function(resource){ 37 | img=resource; 38 | }; 39 | return this; 40 | } 41 | -------------------------------------------------------------------------------- /lib/gajse-input.js: -------------------------------------------------------------------------------- 1 | module.exports={ 2 | input: { 3 | KEY_W: false, 4 | KEY_A: false, 5 | KEY_S: false, 6 | KEY_D: false, 7 | KEY_Q: false, 8 | KEY_E: false, 9 | KEY_ENTER: false, 10 | MOUSE_RIGHT: false, 11 | MOUSE_LEFT: false, 12 | MOUSE_MIDDLE: false 13 | }, 14 | processInput: function(evt,enable){ 15 | var code=evt.keyCode; 16 | switch(code) 17 | { 18 | case 65: 19 | case 37:this.input.KEY_A=enable;break; 20 | case 68: 21 | case 39:this.input.KEY_D=enable;break; 22 | case 83: 23 | case 40:this.input.KEY_S=enable;break; 24 | case 87: 25 | case 38:this.input.KEY_W=enable;break; 26 | case 81:this.input.KEY_Q=enable;break; 27 | case 69:this.input.KEY_E=enable;break; 28 | case 13:this.input.KEY_ENTER=enable;break; 29 | } 30 | }, 31 | enableInput: function(){ 32 | window.addEventListener("keydown",function(evt){ 33 | this.processInput(evt,true); 34 | }.bind(this)); 35 | 36 | window.addEventListener("keyup",function(evt){ 37 | this.processInput(evt,false); 38 | }.bind(this)); 39 | }, 40 | getInput: function(){ 41 | return this.input; 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gajse", 3 | "version": "0.1.2", 4 | "description": "GAJSE - Graphic Adventure JavaScript Engine", 5 | "main": "gajse.js", 6 | "homepage": "http://adrianarroyocalle.github.io/gajse", 7 | "scripts": { 8 | "preinstall": "echo Welcome to GAJSE", 9 | "install": "echo Installing GAJSE", 10 | "test": "grunt test" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "https://github.com/AdrianArroyoCalle/gajse" 15 | }, 16 | "keywords": [ 17 | "graphic", 18 | "adventure", 19 | "3d", 20 | "maker", 21 | "engine" 22 | ], 23 | "author": { 24 | "name" : "Adrián Arroyo Calle", 25 | "email" : "adrian.arroyocalle@gmail.com", 26 | "url" : "http://adrianarroyocalle.github.io" 27 | }, 28 | "license": "AGPL-3.0", 29 | "bugs": { 30 | "url": "https://github.com/AdrianArroyoCalle/gajse/issues" 31 | }, 32 | "dependencies": { 33 | "three": "~0.68.0", 34 | "mespeak": "~1.4.4-c", 35 | "node-promise": "~0.5.10" 36 | }, 37 | "devDependencies": { 38 | "browserify": "~5.9.1", 39 | "mocha": "~1.21.3", 40 | "grunt": "~0.4.5", 41 | "grunt-browserify": "~2.1.4", 42 | "grunt-contrib-uglify": "~0.5.1", 43 | "grunt-contrib-yuidoc": "~0.5.2", 44 | "grunt-release-it": "~0.2.0" 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /lib/gajse-mesh-actions.js: -------------------------------------------------------------------------------- 1 | var THREE=require("three"); 2 | 3 | /** 4 | * gajse-mesh-actions.js 5 | * @exports 6 | * @constructor 7 | * @param overwrite - An array for overwrite the default parameters 8 | * @module The MeshActions module exports options for actual generated meshes. 9 | */ 10 | exports.MeshActions=function MeshActions(overwrite){ 11 | /** 12 | * Adds a point of Positional Audio in the mesh 13 | * @public 14 | * @author Adrian Arroyo Calle 15 | * @exports 16 | * @fires GAJSE_AddPositionalAudio 17 | * @method Add a source of positional audio in the mesh place 18 | * @param resource - The resource name. It should be Audio. 19 | * @param intensity - The intensity factor. The final intensity value for the audio depends on this. 20 | * @see addTextCallback 21 | * @since 0.0.2 22 | * @version 0.1.0 23 | * */ 24 | 25 | this.addPositionalAudio= function(resource,intensity){ 26 | var event=new CustomEvent("GAJSE_AddPositionalAudio",{"detail" : {"resource": resource, "position": this.position, "intensity": intensity}}); 27 | document.dispatchEvent(event); 28 | }; 29 | this.addCollectableItem=function(){ 30 | 31 | }; 32 | this.makeCharacter=function(){ 33 | 34 | }; 35 | this.position= { 36 | x: 0, 37 | y: 0, 38 | z: 0 39 | }; 40 | for(var over in overwrite) 41 | { 42 | this[over]=overwrite[over]; 43 | } 44 | return this; 45 | } 46 | -------------------------------------------------------------------------------- /lib/gajse-cutscene.js: -------------------------------------------------------------------------------- 1 | /* 2 | * gajse-custscene.js 3 | */ 4 | var storage=require("./gajse-slim-storage"); 5 | 6 | module.exports={ 7 | video: "", 8 | callback: "", 9 | finishCutscene: function(evt){ 10 | document.body.removeChild(evt.target); 11 | if(typeof(this.callback) == "function") 12 | this.callback(); 13 | }, 14 | playCutscene: function(resource,cback,subtitles){ 15 | this.callback=cback; 16 | this.video=document.createElement("video"); 17 | this.article=document.getElementById("gajse"); 18 | this.article.style.position="relative"; 19 | this.video.style.position="absolute"; 20 | this.video.style.float="left"; 21 | this.video.style.top="0px"; 22 | this.video.style.left="0px"; 23 | this.video.style.height=window.innerHeight+"px"; 24 | this.video.style.width=window.innerWidth+"px"; 25 | this.video.addEventListener("click",this.finishCutscene.bind(this)); 26 | this.video.addEventListener("ended",this.finishCutscene.bind(this)); 27 | document.body.appendChild(this.video); 28 | this.video.src=storage.getURLResourceAs(resource,"video/webm"); 29 | this.video.play(); 30 | 31 | if(typeof(subtitles) === typeof(Array)) 32 | { 33 | subtitles.forEach(function(subtitle){ 34 | var track=document.createElement("track"); 35 | track.srclang=subtitle.lang; 36 | track.kind="subtitles"; 37 | track.label=subtitle.label; 38 | track.src=storage.getURLResourceAs(subtitle.resource,"text/vtt"); 39 | this.video.appendChild(track); 40 | }.bind(this)); 41 | } 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /Gruntfile.js: -------------------------------------------------------------------------------- 1 | module.exports=function(grunt){ 2 | //browserify -r ./lib/gajse-api -r three > gajse.test.js 3 | grunt.initConfig({ 4 | pkg: grunt.file.readJSON("package.json"), 5 | browserify: { 6 | js: { 7 | src: "gajse.js", 8 | dest: "gajse.min.js", 9 | options: { 10 | require: ["three","./lib/gajse-api"] 11 | } 12 | } 13 | }, 14 | uglify: { 15 | options: { 16 | banner: '/*! <%= pkg.name %> <%= grunt.template.today("yyyy-mm-dd") %> */\n' 17 | }, 18 | build: { 19 | src: "gajse.min.js", 20 | dest: "gajse.ugly.js" 21 | } 22 | }, 23 | yuidoc: { 24 | compile:{ 25 | name: "GAJSE", 26 | description: "GAJSE is a JavaScript library for support 3D graphic adventures", 27 | version: "<%= pkg.version %>", 28 | url: "http://adrianarroyocalle.github.io/gajse", 29 | logo: "./gajse.svg", 30 | options: { 31 | paths: ["lib"], 32 | //themedir, 33 | outdir: "doc" 34 | } 35 | } 36 | }, 37 | "release-it" : { 38 | options: { 39 | pkgFiles: ["package.json"], 40 | commitMessage: "Release %s", 41 | tagName: "%s", 42 | tagAnnotation: "Release %s" 43 | } 44 | } 45 | }); 46 | 47 | grunt.loadNpmTasks("grunt-browserify"); 48 | grunt.loadNpmTasks("grunt-contrib-uglify"); 49 | grunt.loadNpmTasks("grunt-contrib-yuidoc"); 50 | grunt.loadNpmTasks("grunt-release-it"); 51 | 52 | grunt.registerTask("default",["browserify"]); 53 | grunt.registerTask("release",["browserify"]); 54 | grunt.registerTask("test",["browserify"]); 55 | 56 | 57 | 58 | 59 | } 60 | -------------------------------------------------------------------------------- /lib/gajse-collision.js: -------------------------------------------------------------------------------- 1 | /* This module verifies if the user can move */ 2 | 3 | var THREE=require("three"); 4 | 5 | module.exports={ 6 | rays: [ 7 | new THREE.Vector3(0, 0, 1), 8 | new THREE.Vector3(1, 0, 1), 9 | new THREE.Vector3(1, 0, 0), 10 | new THREE.Vector3(1, 0, -1), 11 | new THREE.Vector3(0, 0, -1), 12 | new THREE.Vector3(-1, 0, -1), 13 | new THREE.Vector3(-1, 0, 0), 14 | new THREE.Vector3(-1, 0, 1) 15 | ], 16 | raycaster: new THREE.Raycaster(), 17 | movements: { 18 | RIGHT: true, 19 | LEFT: true, 20 | GO: true, 21 | BACK: true 22 | }, 23 | getMovements: function(){ 24 | return this.movements; 25 | }, 26 | refresh: function(position,objects){ 27 | /* objects should be scene.children */ 28 | this.movements.RIGHT=true; 29 | this.movements.LEFT=true; 30 | this.movements.GO=true; 31 | this.movements.BACK=true; 32 | for(var i=0;i 0 && collisions[0].distance <= 1) 37 | { 38 | if(i==3 || i==4 || i==5) 39 | { 40 | this.movements.GO=false; 41 | } 42 | if(i==0 || i==1 || i==7) 43 | { 44 | this.movements.BACK=false; 45 | } 46 | if(i==1 || i==2 || i==3) 47 | { 48 | this.movements.RIGHT=false; 49 | } 50 | if(i==5 || i==6 || i==7) 51 | { 52 | this.movements.LEFT=false; 53 | } 54 | if(collisions[0].object.gajse != undefined) 55 | { 56 | 57 | if(collisions[0].object.gajse.textCallback != undefined) 58 | collisions[0].object.gajse.textCallback.speak(); 59 | } 60 | } 61 | } 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /lib/gajse-slim-storage.js: -------------------------------------------------------------------------------- 1 | /* 2 | * gajse-slim-storage.js we don't use databases 3 | */ 4 | 5 | module.exports={ 6 | storage: {}, 7 | resTotal: 0, 8 | resCount: 0, 9 | callback: "", 10 | putResource: function(resource,data){ 11 | console.log("ADDING RESOURCE: "+resource+" "+(this.resCount/this.resTotal)*100+"%"); 12 | this.storage[resource]=data; 13 | this.resCount++; 14 | if(this.resTotal == this.resCount){ 15 | this.callback(); 16 | } 17 | }, 18 | putHTTPResource: function(resource,url){ 19 | var xhr=new XMLHttpRequest(); 20 | xhr.open("GET",url+"?timestamp="+new Date().getTime()); 21 | xhr.responseType="arraybuffer"; 22 | xhr.addEventListener("load",function(){ 23 | this.putResource(resource,xhr.response); 24 | }.bind(this)); 25 | xhr.send(); 26 | }, 27 | getResource: function(resource){ 28 | return this.storage[resource]; 29 | }, 30 | getURLResourceAs: function(resource,mimeType){ 31 | var res=this.storage[resource]; 32 | var blob=new Blob([res],{type: mimeType}); 33 | return URL.createObjectURL(blob); 34 | }, 35 | setupResources: function(json,dir){ 36 | for(var resName in json) 37 | { 38 | this.resTotal++; 39 | this.putHTTPResource(resName,dir+json[resName]); 40 | } 41 | }, 42 | init: function(confFiles,callback){ 43 | this.callback=callback; 44 | for(var resType in confFiles) 45 | { 46 | var resHttp=new XMLHttpRequest(); 47 | resHttp.open("GET",confFiles[resType]+"resources.json",true); 48 | resHttp.responseType="json"; 49 | resHttp.resDir=confFiles[resType]; 50 | resHttp.addEventListener("load",function(evt){ 51 | this.setupResources(evt.target.response,evt.target.resDir); 52 | }.bind(this)); 53 | resHttp.send(); 54 | } 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /lib/gajse-hud.js: -------------------------------------------------------------------------------- 1 | /* 2 | * gajse-hud.js Implements a SVG based HUD customizable 3 | */ 4 | var version=require("./gajse-version"); 5 | var storage=require("./gajse-slim-storage"); 6 | var { Feature }=require("./gajse-version"); 7 | module.exports={ 8 | doc: "", 9 | div: "", 10 | localTime: "", 11 | slot: "", 12 | itemName: "", 13 | mode: "", 14 | minVersion: "", 15 | maxVersion: "", 16 | setHUD: function(resource){ 17 | var hud=storage.getURLResourceAs(resource,{type: "image/svg+xml"}); 18 | var xhr=new XMLHttpRequest(); 19 | xhr.open("GET",hud,true); 20 | xhr.addEventListener("load",function(){ 21 | var parser=new DOMParser(); 22 | this.doc=parser.parseFromString(xhr.responseText,"image/svg+xml"); 23 | this.localTime=this.doc.getElementById("local-time"); 24 | this.slot=this.doc.getElementById("slot"); 25 | this.itemName=this.doc.getElementById("itemName"); 26 | this.mode=this.doc.getElementById("mode"); 27 | this.minVersion=this.doc.getElementById("minVersion"); 28 | this.maxVersion=this.doc.getElementById("maxVersion"); 29 | this.div=document.createElement("div"); 30 | this.div.id="GAJSE_HUD"; 31 | this.div.style.width="128px"; 32 | this.div.style.height="128px"; 33 | this.div.style.position="relative"; 34 | this.div.style.position="absolute"; 35 | this.div.style.float="left"; 36 | this.div.style.top="0px"; 37 | this.div.style.left="0px"; 38 | this.div.appendChild(this.doc.documentElement); 39 | document.body.appendChild(this.div); 40 | this.changeSelectedItem(); 41 | }.bind(this)); 42 | xhr.send(); 43 | }, 44 | changeSelectedItem: function(item){ 45 | /* CHange values */ 46 | }, 47 | renderHUD: function(){ 48 | var feature=new Feature("0.0.2","GAJSE HUD",this.minVersion); 49 | if(feature.check()) 50 | { 51 | /* CHANGE VALUES */ 52 | } 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /lib/gajse-loader.js: -------------------------------------------------------------------------------- 1 | exports.loadConfiguration=function (callback){ 2 | /* Loads the GAJSE JSON file */ 3 | this.domElement=document.getElementById("gajse"); 4 | if(this.domElement==undefined) 5 | { 6 | console.exception("There isn't any DOM element with the 'gajse' id"); 7 | } 8 | this.jsonFile=this.domElement.dataset.gajse; 9 | if(this.jsonFile==undefined) 10 | { 11 | console.exception("The 'gajse' element doesn't have a data-gajse attributte"); 12 | } 13 | console.log("LOADING: " + this.jsonFile); 14 | var xhr=new XMLHttpRequest(); 15 | xhr.open("GET",this.jsonFile,true); 16 | xhr.responseType="json"; 17 | xhr.addEventListener("load",function(evt){ 18 | console.log("PARSED: " + this.jsonFile); 19 | callback(xhr.response); 20 | }.bind(this)); 21 | xhr.send(); 22 | } 23 | exports.loadEnvironment=function(data){ 24 | var THREE=require("three"); 25 | var loop=require("./gajse-loop"); 26 | var msg=require("./gajse-msg"); 27 | var version=require("./gajse-version"); 28 | var input=require("./gajse-input"); 29 | 30 | var logo=THREE.ImageUtils.loadTexture(data.icon64); 31 | var scene=new THREE.Scene(); 32 | var camera=new THREE.PerspectiveCamera(45,window.innerWidth/window.innerHeight,0.25,100); 33 | camera.position.z=2; 34 | var loadingGeo=new THREE.BoxGeometry(50,50,50); 35 | var loadingMat=new THREE.MeshBasicMaterial({map: logo}); 36 | var loadingBox=new THREE.Mesh(loadingGeo, loadingMat); 37 | scene.add(loadingBox); 38 | var renderer=new THREE.WebGLRenderer(); 39 | renderer.setSize(window.innerWidth,window.innerHeight); 40 | document.getElementById("gajse").appendChild(renderer.domElement); 41 | 42 | loop.startLoop(renderer,scene,camera, loadingBox, data, input); 43 | 44 | var desc=msg.say2(data.description, false, 0, "top","blue"); 45 | var copyright=msg.say2("Another amazing project using GAJSE " + version.showVersion(),false,0,"bottom","red"); 46 | setTimeout(function(){ 47 | document.getElementById("gajse").removeChild(desc); 48 | document.getElementById("gajse").removeChild(copyright); 49 | },2500); 50 | } 51 | -------------------------------------------------------------------------------- /lib/gajse-version.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Some utilities related to versioning 3 | * @module gajse-version 4 | * @static 5 | * @since 0.0.1 6 | */ 7 | 8 | var version="0.1.0"; 9 | 10 | 11 | /** 12 | * YUIDoc class for the static methods under gajse-version 13 | * @class gajse-version 14 | * @static 15 | */ 16 | module.exports={ 17 | /** 18 | * Gets the current version of GAJSE 19 | * @method showVersion 20 | * @static 21 | * @since 0.0.1 22 | * @return {String} The current version using [SemVer](http://semver.org) 23 | * @example 24 | * var gajseVersion=version.showVersion(); 25 | */ 26 | showVersion: function(){ 27 | return version; 28 | }, 29 | /** 30 | * @method checkFeatureVersion 31 | * @static 32 | * @param {Feature} feature Check if we can use a feature 33 | * @return {Boolean} True if it can be used, false otherwise 34 | * @since 0.0.4 35 | * @beta 36 | */ 37 | checkFeatureVersion: function(feature){ 38 | if(feature.minVersion>=this.showVersion()) 39 | return true; 40 | else 41 | return false; 42 | }, 43 | showLicense: function(){ 44 | return "GAJSE LICENSE\nThe GAJSE license is under the Affero GPL or a Commercial license"; 45 | } 46 | }; 47 | 48 | /** 49 | * A tool for know if a feature is available. Should be used via 3rd party developers 50 | * @class Feature 51 | * @constructor 52 | * @param {Float} minVersion The mininmun version of the feature 53 | * @param {String} description A little description about the feature 54 | * @param {Float} contentVersion The GAJSE files version 55 | * @beta 56 | * @since 0.0.4 57 | */ 58 | exports.Feature=function Feature(minVersion,description,contentVersion){ 59 | this.minVersion=minVersion; 60 | this.description=description; 61 | this.contentVersion=contentVersion; 62 | /** 63 | * @method check 64 | * @return {Boolean} True if available 65 | * @beta 66 | * @since 0.0.4 67 | */ 68 | this.check=function(){ 69 | if(this.minVersion>=version) 70 | { 71 | if(this.contentVersion>=version) 72 | { 73 | return true; 74 | }else 75 | return false; 76 | }else 77 | return false; 78 | }; 79 | return this; 80 | }; 81 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | GAJSE 2 | ===== 3 | 4 | Graphic Adventure JavaScript Engine 5 | 6 | ##Introduction 7 | GAJSE is a JavaScript library used to create graphic adventures in a real 3D environment that runs on your browser. It runs on all modern browsers and it has a lot of features. 8 | 9 | ##Features 10 | 11 | * Resource system with cache 12 | * Easy to learn API 13 | * Complete, real 3D engine thanks to Three.js 14 | * Load JSON, Collada and OBJ models via Three.js 15 | * Translations API (via i18next) 16 | * Positional audio 17 | * Integrated collision engine 18 | * Cutscenes API 19 | * Simple conversation format 20 | * Custom HUD in SVG 21 | * Items API 22 | * Characters API 23 | * Integration with node 24 | * Text-2-Speech availible with meSpeak 25 | * Support for keyboard input, mouse input and touch input 26 | 27 | ##Installation 28 | GAJSE is availible on npm. Do the following for use it on a project. 29 | 30 | ``` 31 | npm install gajse --save 32 | ``` 33 | 34 | Or you can just download the _gajse.min.js_ file here. 35 | 36 | ##Building 37 | 38 | You can manually build gajse: 39 | 40 | ``` 41 | git clone https://github.com/AdrianArroyoCalle/gajse 42 | 43 | cd gajse 44 | 45 | npm install 46 | 47 | grunt 48 | 49 | ``` 50 | 51 | At your option use uglify-js. 52 | 53 | ##Tutorial 54 | 55 | GAJSE has an official tutorial availible from here or you can use La Maquinaria de Videojuegos which offers a GUI system to create GAJSE games: 56 | 57 | * [Official tutorial](http://github.com/AdrianArroyoCalle/gajse/wiki/Tutorial-1) 58 | * [La Maquinaria de Videojuegos](http://lamaquinariadevideojuegos-divel.rhcloud.com) 59 | 60 | ##Screenshots 61 | 62 | We haven't got any screenshot yet. Please, be patient. 63 | 64 | ##Price 65 | GAJSE is under the Affero GPL license so: 66 | 67 | * You can use it for open source projects 68 | * You should give us credit 69 | * You can use it on hosted servers, but you need the full source 70 | * You announce the changes made by you 71 | * You can use it on commercial projects 72 | 73 | But if you need full control of the library, GAJSE offers a Commercial Release: 74 | 75 | * You pay for a Commercial License of GAJSE the only price of 50$ 76 | * You can do whatever you want 77 | * 78 | -------------------------------------------------------------------------------- /lib/gajse-api.js: -------------------------------------------------------------------------------- 1 | /* gajse-api */ 2 | var loop=require("./gajse-loop"); 3 | var THREE=require("three"); 4 | var storage=require("./gajse-slim-storage"); 5 | var cutscene=require("./gajse-cutscene"); 6 | var { Item }=require("./gajse-item"); 7 | var { MeshActions }=require("./gajse-mesh-actions"); 8 | var { Light }=require("./gajse-light"); 9 | var { ScriptedText, Question, Answer }=require("./gajse-text"); 10 | var { Character }=require("./gajse-character"); 11 | var Action = require("./gajse-action").Action; 12 | var version=require("./gajse-version"); 13 | 14 | module.exports={ 15 | apiVersion: "0.0.3", 16 | Item: Item, 17 | Light: Light, 18 | Character: Character, 19 | Action: Action, 20 | ScriptedText: ScriptedText, 21 | Question: Question, 22 | Answer: Answer, 23 | version: version, 24 | storage: storage, 25 | MeshActions: MeshActions, 26 | addObject: function(resource,position,text){ 27 | var objectFile=storage.getURLResourceAs(resource,"application/json"); 28 | new THREE.JSONLoader().load(objectFile,function(geo,mat){ 29 | var mesh=new THREE.Mesh(geo,new THREE.MeshFaceMaterial(mat)); 30 | mesh.updateMatrix(); 31 | mesh.gajse={}; 32 | mesh.gajse.textCallback=text; 33 | var event=new CustomEvent("GAJSE_PushMesh",{"detail": {"mesh": mesh, "position": position}}); 34 | document.dispatchEvent(event); 35 | }); 36 | return this.MeshActions({position: position}); 37 | }, 38 | addManualObject: function(mesh,position,text){ 39 | mesh.gajse={}; 40 | mesh.gajse.textCallback=text; 41 | var event=new CustomEvent("GAJSE_PushMesh",{"detail": {"mesh": mesh,"position": position}}); 42 | document.dispatchEvent(event); 43 | 44 | return this.MeshActions({position: position}); 45 | }, 46 | getResource: function(resource){ 47 | return storage.getResource(resource); 48 | }, 49 | setBackgroundMusic: function(resource){ 50 | var event=new CustomEvent("GAJSE_SetBackgroundMusic",{"detail" : {"resource" : resource}}); 51 | document.dispatchEvent(event); 52 | }, 53 | playSFX: function(){ 54 | 55 | }, 56 | changeScene: function(file){ 57 | var event=new CustomEvent("GAJSE_LoadScene",{"detail" : {"file" : file}}); 58 | document.dispatchEvent(event); 59 | }, 60 | /** 61 | * Plays a Cutscene using the GAJSE Cutscene API. Resources can be WebM, VP9, Ogg Theora (OGV). MP4 and other might be supported depending on the browser. 62 | * Subtitles use WebVTT format and they are supported on the browsers that implement it. 63 | * @param resource - The resource name of the video 64 | * @param callback - The callback when the video finish (or is skipped) 65 | * @param subtitles - An array containing GAJSE Subtitles Objects 66 | * */ 67 | playCutscene: function(resource,callback,subtitles){ 68 | cutscene.playCutscene(resource,callback,subtitles); 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /lib/gajse-audio.js: -------------------------------------------------------------------------------- 1 | /** 2 | * A positional audio based system 3 | * @module gajse-audio 4 | */ 5 | 6 | var storage=require("./gajse-slim-storage"); 7 | 8 | /** 9 | * A positional audio system using WebAudio 10 | * @class gajse-audio 11 | * @since 0.0.3 12 | * @static 13 | * @uses gajse-slim-storage 14 | */ 15 | module.exports={ 16 | /** 17 | * @property audioContext 18 | * @type AudioContext 19 | * @default null 20 | * @private 21 | */ 22 | audioContext: "", 23 | /** 24 | * @property gainsNodes 25 | * @type Array 26 | * @default [] 27 | * @private 28 | */ 29 | gainsNodes: [], 30 | audioPos: {x: 0, y: 0, z: 0}, 31 | /** Enables the Audio System 32 | * @method enableAudio 33 | * @since 0.0.3 34 | * */ 35 | enableAudio: function(){ 36 | window.AudioContext = window.AudioContext || window.webkitAudioContext; 37 | this.audioContext=new AudioContext(); 38 | document.addEventListener("GAJSE_SetBackgroundMusic",function(evt){ 39 | console.log("SET BACKGROUND MUSIC: "+evt.detail.resource); 40 | var data=storage.getResource(evt.detail.resource); 41 | this.audioContext.decodeAudioData(data,function(buffer){ 42 | var source=this.audioContext.createBufferSource(); 43 | source.buffer=buffer; 44 | source.connect(this.audioContext.destination); 45 | source.start(0); 46 | }.bind(this)); 47 | }.bind(this)); 48 | document.addEventListener("GAJSE_AddPositionalAudio",function(evt){ 49 | var intensity=evt.detail.intensity; 50 | var position=evt.detail.position; 51 | var data=storage.getResource(evt.detail.resource); 52 | this.audioContext.decodeAudioData(data,function(buffer){ 53 | var source=this.audioContext.createBufferSource(); 54 | source.buffer=buffer; 55 | var node=this.audioContext.createGain(); 56 | source.connect(node); 57 | node.connect(this.audioContext.destination); 58 | var gainNode={ 59 | intensity: intensity, 60 | position: position, 61 | node: node, 62 | source: source 63 | }; 64 | gainNode.source.start(0); 65 | this.gainsNodes.push(gainNode); 66 | }.bind(this)); 67 | }.bind(this)); 68 | document.addEventListener("GAJSE_ResetAudio",function(){ 69 | 70 | }); 71 | document.addEventListener("GAJSE_PlaySFX",function(){ 72 | 73 | }); 74 | document.addEventListener("GASJE_PlayText",function(){ 75 | 76 | }); 77 | }, 78 | /** 79 | * Updates the audio with a new position 80 | * @method setAudioPosition 81 | * @since 0.0.3 82 | * @param {THREE.Vector3} pos The new position 83 | */ 84 | setAudioPosition: function(pos){ 85 | this.audioPos=pos; 86 | this.gainsNodes.forEach(function(gainNode){ 87 | var firstOperator=Math.pow(gainNode.position.x-pos.x,2); 88 | var secondOperator=Math.pow(gainNode.position.y-pos.y,2); 89 | var square=Math.sqrt(firstOperator+secondOperator)+1; 90 | var value=(gainNode.intensity/square)+0.001; 91 | gainNode.node.gain.value=value; 92 | }); 93 | } 94 | } 95 | -------------------------------------------------------------------------------- /lib/gajse-msg.js: -------------------------------------------------------------------------------- 1 | var { Question }=require("./gajse-text"); 2 | 3 | module.exports={ 4 | /* IN A FUTURE USE CSS MESSAGE, AND MADE POSSIBLE SKIP IT */ 5 | stack: [], 6 | available: true, 7 | say2: function(text, skip, duration, position, color){ 8 | console.log(text); 9 | var div=document.createElement("div"); 10 | div.style.position="absolute"; 11 | div.style.width=100; 12 | div.style.height=100; 13 | div.style.color=color; 14 | div.style.backgroundColor="transparent"; 15 | div.textContent=text; 16 | if(position=="top") 17 | div.style.top="100px"; 18 | if(position=="bottom") 19 | div.style.bottom="100px"; 20 | div.style.left="100px"; 21 | document.getElementById("gajse").style+="text-align: center;"; 22 | document.getElementById("gajse").appendChild(div); 23 | return div; 24 | }, 25 | tryToSay: function(){ 26 | if(this.available && this.stack.length>0) 27 | { 28 | this.available=false; 29 | var current=this.stack.shift(); 30 | if(typeof(current.text) == typeof("STRING")) 31 | { 32 | var duration=current.text.length; 33 | document.getElementById("gajse").style.position="relative"; 34 | var div=document.createElement("div"); 35 | div.style.position="absolute"; 36 | div.style.float="left"; 37 | div.style.bottom="100px"; 38 | div.style.left="100px"; 39 | div.style.color=current.color; 40 | div.textContent=current.text; 41 | document.getElementById("gajse").appendChild(div); 42 | setTimeout(function(){ 43 | document.getElementById("gajse").removeChild(div); 44 | this.available=true; 45 | this.tryToSay(); 46 | }.bind(this),duration*250); 47 | }else{ 48 | document.getElementById("gajse").style.position="relative"; 49 | var div=new Array; 50 | for(var i=0;i 2 | 3 | 4 | 18 | GAJSE logo 20 | 22 | 42 | 50 | 51 | 53 | 54 | 56 | image/svg+xml 57 | 59 | GAJSE logo 60 | 11/05/2014 61 | 62 | 63 | Adrián Arroyo Calle 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | Inkscape 74 | 75 | 76 | The basic logo of GAJSE 77 | 79 | 80 | 82 | 84 | 86 | 88 | 90 | 92 | 93 | 94 | 95 | 100 | 106 | 112 | 118 | 124 | 130 | 136 | 142 | 148 | 154 | 160 | 166 | 172 | 178 | 184 | 190 | 196 | 202 | 208 | 214 | 220 | 226 | 232 | 238 | 244 | 250 | 262 | 274 | GAJSE 286 | 287 | 288 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . --------------------------------------------------------------------------------