This repository has been archived on 2019-05-05. You can view files and clone it, but cannot push or open issues or pull requests.
App/README.md

39 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2016-08-27 01:04:55 -06:00
TerranQuest
====================
TerranQuest is an augmented reality mobile game, written using open web
technologies.
It's compiled with Apache Cordova (or Phonegap if you're into that).
Check out the website at https://terranquest.net.
2016-08-27 01:30:47 -06:00
This repository is usually a little ahead of the current beta release.
2016-09-09 14:29:42 -06:00
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/392f0106a23e4b18be75ee1b27ea09a8)](https://www.codacy.com/app/netsyms/TerranQuest?utm_source=github.com&utm_medium=referral&utm_content=Netsyms/TerranQuest&utm_campaign=Badge_Grade)
2016-09-09 13:58:51 -06:00
2016-08-27 01:30:47 -06:00
Build Notes
2016-08-27 01:04:55 -06:00
--------------------
To get this project ready for build, type `cordova prepare`. This reads the
config.xml, extracting platform and plugin info. Required repositories are
downloaded and installed automatically.
2016-10-04 12:26:50 -06:00
To compile, simply run `cordova build <platform>`. Currently, Android works
great, but iOS has some asset issues.
Server Code
--------------------
Get the server code at https://github.com/Netsyms/TerranQuest-GameServer.
2016-08-27 01:04:55 -06:00
License
--------------------
TerranQuest code (not the graphical assets, like the logos and stuff) is
released under the Apache License 2.0.
If you're going to make your own game and share it, you'll need to put in the
effort to make the graphics yourself, as they are
copyright (c) 2016 Netsyms Technologies, all rights reserved. It's not that hard.
We're just lazy and don't want to separate the pictures out from the code.
If you're just tinkering with the code and aren't sharing binaries, that's fine
2016-08-27 01:30:47 -06:00
though.