Skip to content

Commit

Permalink
First alpha release v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
timjrobinson committed Apr 30, 2017
0 parents commit e5e08eb
Show file tree
Hide file tree
Showing 610 changed files with 113,007 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .gitignore
@@ -0,0 +1,10 @@
/*.sublime-project
/*.sublime-workspace
/logs/HeapSnapshots/*.heapsnapshot
/node_modules/
/build
/.idea
/newrelic_agent.log
.c9
/frontend/dist/
npm-debug.log
190 changes: 190 additions & 0 deletions LICENSE
@@ -0,0 +1,190 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Copyright 2013-2017 T Robinson Enterprises Pty Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
146 changes: 146 additions & 0 deletions README.md
@@ -0,0 +1,146 @@
# Tower Storm

## Moddable Multiplayer Tower Defense

v0.1.0

## Overview

Tower Storm is a Multiplayer Tower Attack and Defense development kit that makes it easy for you to build the Tower Defense game you've always wanted to play. Have you played Tower Defense games in the past and felt they always looked the same? Just a few basic towers that shoot, maybe one that does AOE damage and that's it. Or perhaps you are a fan of the Tower Defense maps in Warcraft 3 or Starcraft with their amazing depth and variety, and want more of that.

With Tower Storm you can go nuts creating the awesome ideas you've had, and it's completely free and open source.

## Getting Started

You can either create a copy of this project on [Cloud9](c9.io) or clone these files to a server or your computer and run from there.

## Pre-requisites

- nodejs >= v4
- npm >= v2

## Running development

- `./init.sh` - This sets up the RethinkDB database, currently Debian/Ubuntu only.
- `npm install`
- `npm install --global gulp-cli webpack`
- `gulp dist`
- `webpack`
- `npm start`

### Running in Cloud9

- Make your application public by click on `Share` in the top right and ticking the public box beside application. This must be done so bots can connect correctly.
- Click Preview -> Preview running application from the top navigation bar

### Running on your desktop

- Add the line `127.0.0.1 ts.dev` to your `/etc/hosts` file.
- Go to `ts.dev:8080` in your browser.

## Running in production

You'll need to do the following steps to setup a production server for towerstorm

- Create a towerstorm user
- Install node v4.x and npm v2 (I recommend using nvm)
- Install git
- Extract Tower Storm files to the towerstorm user home dir (or a game folder)
- Add towerstorm user to syslog group so they can write to /var/log
- Setup environment variables mentioned in section below
- `./init.sh`
- `npm run prod`


## Environment variables

These are all optional

- HOSTNAME - The hostname or url of your server, defaults to `ts.dev` if it's not set which is only useful for development.
- COOKIE_SECRET - Secret key used for encrypting login cookies
- DD_API_KEY - For sending your server metrics to Datadog
- DD_APP_KEY - For sending your server metrics to Datadog




## Modifying Tower Storm

If you just want to modify the gameplay or create your own minions/towers/maps etc you only need to pay attention to 2 folders:

- `/config` - This folder contains JSON files describing things in the game world. You'll notice there are subfolders of minions, towers and maps, you can put new creations in there and they'll automatically be loaded by the game.
- `/frontend/assets` - This is where graphics go for minions/towers/maps.

### Config files

All of the minion/tower/bullet config is stored in the `./config` folder. When you modify these files you only need to refresh the page to see them in action.

### Game code

When modifying any code in the `/game` folder you need to run webpack to recompile it:

```
webpack
```

### Frontend code

When modifying any coffee-script code in the `/frontend` folder you need to run gulp to rebuild it:

```
gulp frontend
```

### Modifying other code

When modifying code in `/botmanager`, `/database`, `/gameserver`, `/logger` or `/lobby` you need to restart the nodejs server to reload it (press `ctrl + c` to kill then run `npm start` again)

## Changelog

0.1.0 - First release

## Versioning / Mod compatability

While Tower Storm is in alpha (before 1.0 release) a minor release (0.1.3 -> 0.2) signifies a breaking change and your mods may stop working, a patch release (0.1.1 -> 0.1.2) is a backwards compatible release.

## Known issues

### Bots aren't automatically joining my game

If you're running on Cloud9 make sure you've made your application public via clicking on `Share` in the top right and ticking the box beside `Application`. This needs to be done because bots currently use the public app to authenticate themselves.

## FAQ

### This is a lot of code without any commit history, where did it all come from?

I started on Tower Storm back in 2013 because I wanted a Tower Defense game that was:

1. Multiplayer
2. Easy to play, with no software required
3. More in depth than anything out there.

This turned out to be a far bigger project than I had anticipated and after 3 years of part time development I gave up on the project.

But of course that desire for an in depth multiplayer tower defense game never went away and still no company has made it happen. So I decided to take the source code for Tower Storm, clean it up and open source it as basically a Tower Defense dev kit that anyone can use to build their own awesome TD games.

This way everyone can create and play the game they always wanted and I don't have to build this all by myself.

### Why is the design so boostrappy / bland?

Most of the UI assets in Tower Storm were purchased, and these licenses are for a single closed source product only, so I had to change all the UI prior to open sourcing. I want to improve it over time, but wanted to get this game out there first.

### Why is there no sound / music?

As above most of the sound / music in Tower Storm was purchased and so couldn't be open sourced. I'd like to re-implement SFX and music in the future.

### Why Angular 1?

When I first started building the frontend in 2013 Angular 1 was the new hotness. I'd like to refactor it to use React but that's a big process and this works for now.

## Future Plans

- In depth documentation on modding
- Move all game information out of config and into `/mods` folder so that modifications are namespaced and easily distributable
- Re-organize tests and get them all working again
- Convert code from coffeescript to es6
- Add user accounts / friends back in (the backend code is there, just need frontend recreated)
11 changes: 11 additions & 0 deletions botmanager/.gitignore
@@ -0,0 +1,11 @@
/*.sublime-project
/*.sublime-workspace
/logs/HeapSnapshots/*.heapsnapshot
/public/js/jquery.js
/node_modules/
/build
/routes.js
/server.js
/.idea
/newrelic_agent.log
.c9
5 changes: 5 additions & 0 deletions botmanager/README.md
@@ -0,0 +1,5 @@
BotManager
======

This is a nodejs app that can spawn bots, make them connect to games, and play Tower Storm (pretty randomly)

0 comments on commit e5e08eb

Please sign in to comment.