Skip to content

Commit a00998c

Browse files
committed
Add readme/license info
1 parent 4f3c5f8 commit a00998c

File tree

2 files changed

+33
-3
lines changed

2 files changed

+33
-3
lines changed

LICENSE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Copyright (c) 2015, Jason Turner <[email protected]>
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5+
6+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7+
8+
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.
9+
10+
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.
11+
12+
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.

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,29 @@
1-
A simple game involving trading of goods and some adventure game story elements.
1+
Spiced: A Tile Based ChaiScript Backed Game Engine
2+
==================================================
3+
4+
# Documentation Status
5+
6+
None.
7+
8+
# Level Editing
9+
10+
You can use the [Tiled](http://www.mapeditor.org/) to edit levels.
11+
12+
# Example Code
13+
14+
The [sample_game](sample_game) contains a simple game involving trading of goods and some adventure game story elements.
215

316
Make sure you talk to all of the characters multiple times, as new story elements
417
become available.
518

6-
Also, a somewhat capable game engine with levels editable with 'tiled'.
19+
To learn about the engine, I suggest you look at the [sample_game/spiced.chai](sample_game/spiced.chai) source file. Then open the
20+
[sample_game/resources](sample_game/resources) folder and look at the .tmx map files. You can open them with Tiled then export them as json files,
21+
overwriting the existing json files in the directory. Relaunch the game and see the differences.
22+
23+
24+
# Sample Tile Sets
725

8-
Please note that most of the artwork comes from opengameart here http://opengameart.org/content/oga-16x16-jrpg-sprites-tiles
26+
Please note that most of the artwork comes from opengameart here: http://opengameart.org/content/oga-16x16-jrpg-sprites-tiles
927

1028
All copyrights for artwork apply.
1129

0 commit comments

Comments
 (0)