Bleugh readme
This commit is contained in:
parent
60c25e259e
commit
545c8bec38
1 changed files with 52 additions and 1 deletions
51
README.md
51
README.md
|
@ -1 +1,52 @@
|
||||||
# Here be spaghetti code.
|
# Here be spaghetti code.
|
||||||
|
|
||||||
|
You probably shouldn't try to use this disorganized mess for anything. That said,
|
||||||
|
if you really want to mess with this game, I'm putting it out there under the BSD
|
||||||
|
license. See the bottom of this doc.
|
||||||
|
|
||||||
|
## Using
|
||||||
|
|
||||||
|
I got fuckin' lazy and didn't set up a proper build system, so you get a batch file
|
||||||
|
instead. Run that and it will create an index.html that embeds all JS files in
|
||||||
|
subfolders. That should be all you need to run the javascript, although to distribute
|
||||||
|
it you're going to have to edit the generated file to use relative paths instead
|
||||||
|
of absolute filesystem paths. (Sorry.)
|
||||||
|
|
||||||
|
Sprites need to be assembled into a sheet in the main assets/ folder with a JSON
|
||||||
|
hash file that PixiJS can pick up. I used TexturePacker while creating this.
|
||||||
|
Name it assets/sprites.{json/png}.
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
|
||||||
|
I made everything. :o Except the frameworks I used. Those are http://www.pixijs.com/
|
||||||
|
for graphics and http://www.createjs.com/soundjs for sound.
|
||||||
|
|
||||||
|
## The license
|
||||||
|
|
||||||
|
Copyright (c) 2016, "RedEnchilada" (Tim B.)
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification,
|
||||||
|
are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
1. Redistributions of source code must retain the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer in the documentation and/or
|
||||||
|
other materials provided with the distribution.
|
||||||
|
|
||||||
|
3. Neither the name of the copyright holder nor the names of its contributors may
|
||||||
|
be used to endorse or promote products derived from this software without specific
|
||||||
|
prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||||
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||||
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||||||
|
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
||||||
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
||||||
|
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
||||||
|
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
||||||
|
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||||
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||||
|
POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
Loading…
Add table
Reference in a new issue