Create gh-pages branch via GitHub

fdsprod · Dec 4, 2016 · 66f9bcf · 66f9bcf
commit 66f9bcf
Show file tree

Hide file tree

Showing 12 changed files with 1,322 additions and 0 deletions.
diff --git a/images/body-bg.jpg b/images/body-bg.jpg
diff --git a/images/download-button.png b/images/download-button.png
diff --git a/images/github-button.png b/images/github-button.png
diff --git a/images/header-bg.jpg b/images/header-bg.jpg
diff --git a/images/highlight-bg.jpg b/images/highlight-bg.jpg
diff --git a/images/sidebar-bg.jpg b/images/sidebar-bg.jpg
diff --git a/index.html b/index.html
@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
+    <link href='https://fonts.googleapis.com/css?family=Architects+Daughter' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
+    <link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
+    <link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
+
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+
+    <title>Twitch2DCS by jeffboulanger</title>
+  </head>
+
+  <body>
+    <header>
+      <div class="inner">
+        <h1>Twitch2DCS</h1>
+        <h2>Allows you to view your Twitch stream chat inside DCS world.  </h2>
+        <a href="https://github.com/jeffboulanger/twitch2dcs" class="button"><small>View project on</small> GitHub</a>
+      </div>
+    </header>
+
+    <div id="content-wrapper">
+      <div class="inner clearfix">
+        <section id="main-content">
+          <h3>
+<a id="goals" class="anchor" href="#goals" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Goals</h3>
+
+<p>Twitch2DCS was primarily created so that DCS World streamers who played in VR could interact with Twitch chat without the need to take the HMD off, or have Twitch chat hooked up to a text-to-speech engine.   By allowing the chat to be visible within DCS the immersion of the game does not have to be broken, and VR streamers can still interact with the audience.  Twitch2DCS is not restricted to VR users, it will work for single monitor and surround setups.</p>
+
+<h3>
+<a id="current-features" class="anchor" href="#current-features" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Current Features</h3>
+
+<ul>
+<li>Separate in-game chat window (similar to multiplayer chat)</li>
+<li>Easily installed to Saved Games directory</li>
+<li>In-game twitch chat communicate both read and write</li>
+<li>Join/Part messages</li>
+<li>Customizable hotkey</li>
+<li>Not dependent on mission start.  The UI exists in every aspect of DCS (Main Menu, Config, Mission Editor, In-Mission) allowing you to always be connected to your twitch audience.</li>
+</ul>
+
+<h3>
+<a id="installation" class="anchor" href="#installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation</h3>
+
+<ol>
+<li>Get the latest version of Twitch2DCS from <a href="https://github.com/jeffboulanger/twitch2dcs/releases">here</a>
+</li>
+<li>Extract the zip to your Saved Games DCS folder
+(C:\Users\ <em>username</em> \Saved Games\DCS)</li>
+<li>Open the file Twitch2DCSConfig.lua in the Config folder with your favorite text editor.</li>
+<li>Add your Twitch username</li>
+<li>Add your Twitch oauth key from <a href="http://twitchapps.com/tmi/">TwitchApps.com</a> make sure you include the <strong>"oauth:"</strong> text</li>
+<li>Launch DCS and enjoy communicating with Twitch from ingame.</li>
+</ol>
+        </section>
+
+        <aside id="sidebar">
+          <a href="https://github.com/jeffboulanger/twitch2dcs/zipball/master" class="button">
+            <small>Download</small>
+            .zip file
+          </a>
+          <a href="https://github.com/jeffboulanger/twitch2dcs/tarball/master" class="button">
+            <small>Download</small>
+            .tar.gz file
+          </a>
+
+          <p class="repo-owner"><a href="https://github.com/jeffboulanger/twitch2dcs"></a> is maintained by <a href="https://github.com/jeffboulanger">jeffboulanger</a>.</p>
+
+          <p>This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the Architect theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.</p>
+        </aside>
+      </div>
+    </div>
+
+
+  </body>
+</html>
diff --git a/javascripts/main.js b/javascripts/main.js
@@ -0,0 +1 @@
+console.log('This would be the main JS file.');
diff --git a/params.json b/params.json
@@ -0,0 +1,6 @@
+{
+  "name": "Twitch2DCS",
+  "tagline": "Allows you to view your Twitch stream chat inside DCS world.  ",
+  "body": "### Goals\r\nTwitch2DCS was primarily created so that DCS World streamers who played in VR could interact with Twitch chat without the need to take the HMD off, or have Twitch chat hooked up to a text-to-speech engine.   By allowing the chat to be visible within DCS the immersion of the game does not have to be broken, and VR streamers can still interact with the audience.  Twitch2DCS is not restricted to VR users, it will work for single monitor and surround setups.\r\n\r\n### Current Features\r\n* Separate in-game chat window (similar to multiplayer chat)\r\n* Easily installed to Saved Games directory\r\n* In-game twitch chat communicate both read and write\r\n* Join/Part messages\r\n* Customizable hotkey\r\n* Not dependent on mission start.  The UI exists in every aspect of DCS (Main Menu, Config, Mission Editor, In-Mission) allowing you to always be connected to your twitch audience.\r\n\r\n### Installation\r\n1. Get the latest version of Twitch2DCS from [here](https://github.com/jeffboulanger/twitch2dcs/releases)\r\n1. Extract the zip to your Saved Games DCS folder\r\n (C:\\Users\\ _username_ \\Saved Games\\DCS)\r\n2. Open the file Twitch2DCSConfig.lua in the Config folder with your favorite text editor.\r\n3. Add your Twitch username\r\n4. Add your Twitch oauth key from [TwitchApps.com](http://twitchapps.com/tmi/) make sure you include the **\"oauth:\"** text\r\n5. Launch DCS and enjoy communicating with Twitch from ingame.\r\n",
+  "note": "Don't delete this file! It's used internally to help with page regeneration."
+}
diff --git a/stylesheets/github-light.css b/stylesheets/github-light.css
@@ -0,0 +1,124 @@
+/*
+The MIT License (MIT)
+
+Copyright (c) 2016 GitHub, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+*/
+
+.pl-c /* comment */ {
+  color: #969896;
+}
+
+.pl-c1 /* constant, variable.other.constant, support, meta.property-name, support.constant, support.variable, meta.module-reference, markup.raw, meta.diff.header */,
+.pl-s .pl-v /* string variable */ {
+  color: #0086b3;
+}
+
+.pl-e /* entity */,
+.pl-en /* entity.name */ {
+  color: #795da3;
+}
+
+.pl-smi /* variable.parameter.function, storage.modifier.package, storage.modifier.import, storage.type.java, variable.other */,
+.pl-s .pl-s1 /* string source */ {
+  color: #333;
+}
+
+.pl-ent /* entity.name.tag */ {
+  color: #63a35c;
+}
+
+.pl-k /* keyword, storage, storage.type */ {
+  color: #a71d5d;
+}
+
+.pl-s /* string */,
+.pl-pds /* punctuation.definition.string, string.regexp.character-class */,
+.pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
+.pl-sr /* string.regexp */,
+.pl-sr .pl-cce /* string.regexp constant.character.escape */,
+.pl-sr .pl-sre /* string.regexp source.ruby.embedded */,
+.pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */ {
+  color: #183691;
+}
+
+.pl-v /* variable */ {
+  color: #ed6a43;
+}
+
+.pl-id /* invalid.deprecated */ {
+  color: #b52a1d;
+}
+
+.pl-ii /* invalid.illegal */ {
+  color: #f8f8f8;
+  background-color: #b52a1d;
+}
+
+.pl-sr .pl-cce /* string.regexp constant.character.escape */ {
+  font-weight: bold;
+  color: #63a35c;
+}
+
+.pl-ml /* markup.list */ {
+  color: #693a17;
+}
+
+.pl-mh /* markup.heading */,
+.pl-mh .pl-en /* markup.heading entity.name */,
+.pl-ms /* meta.separator */ {
+  font-weight: bold;
+  color: #1d3e81;
+}
+
+.pl-mq /* markup.quote */ {
+  color: #008080;
+}
+
+.pl-mi /* markup.italic */ {
+  font-style: italic;
+  color: #333;
+}
+
+.pl-mb /* markup.bold */ {
+  font-weight: bold;
+  color: #333;
+}
+
+.pl-md /* markup.deleted, meta.diff.header.from-file */ {
+  color: #bd2c00;
+  background-color: #ffecec;
+}
+
+.pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
+  color: #55a532;
+  background-color: #eaffea;
+}
+
+.pl-mdr /* meta.diff.range */ {
+  font-weight: bold;
+  color: #795da3;
+}
+
+.pl-mo /* meta.output */ {
+  color: #1d3e81;
+}
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		console.log('This would be the main JS file.');