Create Open PR

.editorconfig

@@ -6,4 +6,4 @@ insert_final_newline = false
 trim_trailing_whitespace = true
 charset = utf-8
 indent_size = 4
-indent_style = tab
+indent_style = tab

.eslintrc.json

@@ -0,0 +1,90 @@
+{
+    "rules": {
+		"dot-notation": [
+			2
+		],
+        "indent": [
+            2,
+            "tab",
+			{
+				"SwitchCase": 1,
+				"ObjectExpression": "first"
+			}
+        ],
+        "quotes": [
+            2,
+            "double"
+        ],
+        "linebreak-style": [
+            2,
+            "unix"
+        ],
+		"no-console": [
+			2,
+			{
+				"allow": ["warn", "error"]
+			}
+		],
+		"no-eq-null":[
+			2
+		],
+		"no-eval":[
+			2
+		],
+		"no-implied-eval":[
+			2
+		],
+		"no-redeclare": [
+			2,
+			{
+				"builtinGlobals": true
+			}
+		],
+		"one-var": [
+			2,
+			"never"
+		],
+		"prefer-const":[
+			2
+		],
+        "semi": [
+            2,
+            "always"
+        ],
+		"keyword-spacing":[
+			2,
+			{
+				"before": true,
+				"after": true,
+				"overrides": {
+					"if": {
+						"before": false
+						},
+					"for": {
+						"before": false
+					},
+					"while": {
+						"before": false
+					}
+				}
+			}
+		],
+		"space-before-blocks":[
+			2,
+			"always"
+		],
+		"space-before-function-paren": [
+			2,
+			"always"
+		],
+		"strict":[
+			2,
+			"global"
+		]
+    },
+    "env": {
+        "es6": true,
+        "browser": true
+    },
+    "extends": "eslint:recommended"
+}

.gitignore

@@ -5,6 +5,7 @@
 .thumbs
 .Thumbs
 .buildconfig
+package-lock.json
 /node_modules
 /cache
 /src

.htaccess

@@ -51,9 +51,6 @@ Deny from env=block_bad_bots
     php_value session.cookie_httponly true
 </IfModule>
 
-# Prevent Iframe
-Header set X-Frame-Options DENY
-
 # Disable server signature
 ServerSignature Off
 

.htmlhintrc

@@ -0,0 +1,18 @@
+{
+    "tagname-lowercase": true,
+    "attr-lowercase": true,
+    "attr-value-double-quotes": true,
+    "doctype-first": true,
+    "tag-pair": true,
+    "spec-char-escape": true,
+    "id-unique": true,
+    "src-not-empty": true,
+    "attr-no-duplication": true,
+	"tag-pair": true,
+	"tag-self-close": false,
+    "title-require": true,
+	"doctype-html5": true,
+	"inline-style-disabled": true,
+	"space-tab-mixed-disabled": "tab",
+	"alt-require": true
+}

.stylelintrc

@@ -0,0 +1,25 @@
+{
+    "rules": {
+		"block-closing-brace-empty-line-before": "never",
+		"block-closing-brace-newline-after": "always",
+		"declaration-block-semicolon-newline-after": "always",
+		"block-opening-brace-space-before": "always",
+		"color-hex-case": "lower",
+		"color-named": "never",
+		"color-no-invalid-hex": true,
+		"function-comma-newline-after": "never-multi-line",
+		"function-comma-space-after": "always",
+		"no-duplicate-selectors": true,
+        "no-eol-whitespace": true,
+		"indentation": "tab",
+		"number-leading-zero": "always",
+		"property-no-unknown": [ true, {
+			"ignoreProperties": [
+				"composes"
+			]
+		}],
+		"selector-list-comma-newline-after": "always",
+		"unit-case": "lower",
+		"unit-whitelist": ["em", "rem", "s", "vmax", "vmin", "vh", "vw", "%", "px"]
+    }
+}

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 - 2017 Diego Islas Ocampo
+Copyright (c) 2015 - 2018 Diego Islas Ocampo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,22 +1,67 @@
 # Monogatari
 Built to bring Visual Novels to the modern web and take them to the next level, making it easy for anyone to create and distribute Visual Novels in a simple way so that anyone can enjoy them on pretty much anywhere, create games with features that no one has ever imagined... it is time for Visual Novels to Evolve.
 
+Website: https://monogatari.io/
+
+Demo: https://monogatari.io/demo/
+
 ## Features
 - Responsive out of the box
-- Plays nice with electron for Desktop apps and phonegap for mobile apps
+- Plays nice with Electron for Desktop apps and Cordova for mobile apps
 - Simple Syntax
+- Progressive Web App Features allowing offline game play
+- Allows you to use any kind of media supported by browsers
+- Compatible with all major browsers
+- Includes libraries for animations and particle effects
+- Allows saving/loading games
 - Extensible, you just can't imagine how much!
 
-Website: https://monogatari.io/
+## What do I need to get Started?
+The first thing about Monogatari that you should probably know is that with it, your visual novel is a web page first and a game later. That means that Monogatari has been created specifically for the web, putting things like responsiveness (the fact that your game will adapt to any screen or device size) first. You don't necessarily need to think of your game this way as well, but you'll certainly take the most out of Monogatari if you do.
+
+### Set up your environment
+
+To develop in Monogatari you would need the same as to develop a webpage, you just need a text editor capable of editing HTML, Javascript and CSS, which means that pretty much any text editor should work, even Windows NotePad but to make it easier, you probably want one with code syntax highlighting.
+
+Some recommended (and free) ones include:
+
+* [Atom](https://atom.io/)
+* [Brackets](http://brackets.io/)
+* [Visual Studio Code](https://code.visualstudio.com)
+
+Take a look at them and pick the one you like the most and feel comfortable with, this will be your main tool from now on.
+
+Now, you can always open a website by just clicking the file (index.html) and opening it with your browser, however there are small aspects of Monogatari that work better when served through a web server. You don't need anything fancy for this, in fact there's a perfectly fine web server you can [download from the Chrome Store](https://chrome.google.com/webstore/detail/web-server-for-chrome/ofhbbkphhbklhfoeikjpcbhemlocgigb)
+
+As previously mentioned, the use of a web server is completely optional, you can just open your game with the browser as a file and it will run just fine, the web server will allow you to test features such as the Service Workers, needed for Monogatari's offline support and asset preloading.
+
+### Workflow
+
+Ok so now you have the environment set up, you have some idea on what the files you got are for so how can you start developing your game?
+
+1. Try the game first, open the index.html file inside the directory you just unzipped and play the sample game through.
+2. Once you've played it once, open the directory (the one you unzipped) with the editor you chose to start making changes.
+3. Open the script.js file with your editor, find the variable called ˋscriptˋ, as you'll see, all the dialogs you just saw are just a simple list in there. More information can be found in [the documentation](https://monogatari.io/documentation/script/text/).
+4. Change one of the dialogs, save the file and reload the game (just like you reload a website).
+5. Play it again and you'll see the dialog changed just like you made it.
+6. Now try adding more dialog to it and you'll quickly get how things are done.
+7. Once you've gotten yourself used to adding dialogs, [add a scene](https://monogatari.io/documentation/script/scenes/) as a challenge, that means you'll have to add your image file to the ˋimg/scenes/ directoryˋ, more instructions are on the link.
+
+If you manage to do all that, congratulations! You just made your first game and are probably more familiarized with the workflow you'll be using, just make changes, save, reload, try and repeat!
 
 ## Documentation
-You can see the documentation in https://monogatari.io/documentation/
+You can take a look at the documentation in https://monogatari.io/documentation/
 
-You can also contribute to the documentation in the [Website repository](https://github.com/Hyuchia/MonogatariWebsite)
+You can also contribute to it in the [Documentation repository](https://github.com/Monogatari/Documentation)
 
-## Contributing
 
-If you have contributed to this project, or in the webpage, please make sure you are listed in the contributors list of the website, you can add yourself in the [contributors file](https://github.com/Hyuchia/MonogatariWebsite/blob/master/templates/contributors.html) of the website
+## Get in Touch
+If you have any doubt, problem or just want some help please contact me, I'll be glad to help in any way I can. Even though Monogatari is simple enough and you can find many resources online, I know it can be hard to get started and sometimes the documentation is not clear enough, so really, contact me anytime!
+
+You can join the [Discord Server](https://discord.gg/gWSeDTz), send me an email, DM me at [Twitter](https://twitter.com/Hyuchia), and [Mastodon](https://mastodon.social/@HyuchiaDiego) as well.
+
+## Contributing
+Contributions are always welcome! If you have contributed to this project, or in the website, please make sure you are listed in the contributors list of the website, you can add yourself in the [contributors file](https://github.com/Monogatari/Website/blob/master/templates/contributors.html) of the website
 
 ## License
-Monogatari is a Free Open Source Software project released under the [MIT License](https://raw.githubusercontent.com/Hyuchia/Monogatari/master/LICENSE).
+Monogatari is a Free Open Source Software project released under the [MIT License](https://raw.githubusercontent.com/Monogatari/Monogatari/master/LICENSE).

electron.js

@@ -1,15 +1,30 @@
-const {app, BrowserWindow} = require('electron');
-const path = require('path');
-const url = require('url');
+/**
+ * =======================================
+ * Monogatari Electron Configuration
+ * =======================================
+ **/
 
-// Keep a global reference of the window object, if you don't, the window will
+"use strict";
+
+/* global require */
+/* global process */
+/* global __dirname */
+
+const {app, BrowserWindow} = require("electron");
+const path = require("path");
+const url = require("url");
+
+// Keep a global reference of the window object, if you don"t, the window will
 // be closed automatically when the JavaScript object is garbage collected.
 let win;
 
-function createWindow() {
+function createWindow () {
 	// Create the browser window.
 	win = new BrowserWindow({
 
+		// Title that will be shown in the window (Your game's title)
+		title: "",
+
 		// Set the minimal window size
 		minWidth: 640,
 		minHeight: 360,
@@ -29,23 +44,22 @@ function createWindow() {
 
 		// Full Screen options
 		fullscrenable: true,
-		fullscreen: false,
 
 		// Set an icon for the window
-		icon: __dirname + '/img/icons/icon_128x128.png'
+		icon: __dirname + "/img/icons/icon_128x128.png"
 	});
 
 	// and load the index.html of the app.
 	win.loadURL(url.format(
 		{
-			pathname: path.join(__dirname, 'index.html'),
-			protocol: 'file:',
+			pathname: path.join(__dirname, "index.html"),
+			protocol: "file:",
 			slashes: true
 		}
 	));
 
 	// Emitted when the window is closed.
-	win.on('closed', () => {
+	win.on("closed", () => {
 		// Dereference the window object, usually you would store windows
 		// in an array if your app supports multi windows, this is the time
 		// when you should delete the corresponding element.
@@ -56,24 +70,24 @@ function createWindow() {
 // This method will be called when Electron has finished
 // initialization and is ready to create browser windows.
 // Some APIs can only be used after this event occurs.
-app.on('ready', createWindow);
+app.on("ready", createWindow);
 
 // Quit when all windows are closed.
-app.on('window-all-closed', () => {
+app.on("window-all-closed", () => {
 	// On OS X it is common for applications and their menu bar
 	// to stay active until the user quits explicitly with Cmd + Q
-	if (process.platform !== 'darwin') {
+	if (process.platform !== "darwin") {
 		app.quit();
 	}
 });
 
-app.on('activate', () => {
-	// On OS X it's common to re-create a window in the app when the
+app.on("activate", () => {
+	// On OS X it"s common to re-create a window in the app when the
 	// dock icon is clicked and there are no other windows open.
 	if (win === null) {
 		createWindow();
 	}
 });
 
-// In this file you can include the rest of your app's specific main process
+// In this file you can include the rest of your app"s specific main process
 // code. You can also put them in separate files and require them here.