My project for Ludum Dare 38
A Small World
MIT (see LICENSE)
Let it begin!
This will be be a 2D single-player game wherein you will play as a small planet orbiting a star, and the planet will be "attacked" by a variety of threats from out in the vast universe. These attacks will occur in waves, and during the intervening time you will be able to prepare yourself for the next attack. You need to use and upgrade technology to defend your small and fragile planet from the harsh and aggressive universe for as long as you can. Time is your primary score, but skill and efficiency will earn you points that will allow you to obtain new tools to defend your planet for just that much longer.
The game will be a web-based game written primarily in JavaScript. It should be able to run in any up-to-date browser.
This project is built on top of the excellent Phaser (phaser-ce) HTML5 game
engine/framework. This is the only dependency that needs to be present to run
the game. Phaser is, like this game, licensed with the MIT license. I've
provided a link to the license below. It can be installed using either make
or bower install from the root of the repository.
Due to some of the advanced features used by the code in this web application, we are unable to provide indefinite backwards compatibility. The following is a list of the supported browsers. Note that browsers not supported might work, it just means we won't be putting any effort in getting it to work on that browser.
- Chrome 50+
- Firefox 45+
- Edge 14+
- Internet Explorer 11
- Safari 10+
- iOS 9.3+
- Android 4.4+
- Opera 42+
To build this software, assuming you possess all dependencies, then all you need to do is execute the following command from the source code root:
makeYep, that's seriously all there is to it. Unless you don't have all of the dependencies, then look over the build dependencies list.
- GNU make
- Build system
- Website
- OSX: install Xcode
- Debian:
sudo apt-get install make
- FindUtils
- The command
findandxargsamong others (used for preparing the source code) - Website
- OSX: included by default
- Debian: included by default
- The command
- Rename (util-linux)
- The command
rename(also used for preparing the source code) - Git Repo
- OSX:
brew install rename - Debian: included by default
- The command
- Sass
- Webpack
- Babel
- Babel Loader
- Babel loader for Webpack
- GitHub
npm install
- Babel Env Preset
- Our chosen preset for Babel (don't install this globally, it doesn't work that way)
- GitHub
npm install
- Google Closure Compiler (as
closure-compiler, use symlink if different) - Yahoo! YUI Compressor (as
yuicompressor, use symlink if different)
Also note that if you're missing gem or npm (and therefore, probably
don't have Sass or Browserify), then you'll need to get those as well.
- Ruby (and Gem Package Manager)
- Node.JS (and Node Package Manager)
And last but not least, if you're on OSX and brew commands aren't working,
then you need to download HomeBrew from here.
Additionally, if you're on any non-debian-based distro, you can probably change
the commands from apt-get install to yum install or pacman -S,
and if not, hopefully you're a resourceful linux user, and you can figure it out
somehow.
If you're on windows, there's probably a way to do it, and some Google-fu can help you with that. You might be better off building it in a linux virtual machine, though, so don't rule that out.
The build system (makefile) also includes some methods for publishing the code online. For this, you have three targets:
make publish-all(publishes to development and production sites)make publish(publishes to production site only)make publish-dev(publishes to development site only)
The publishing functionality of the build system has one dependency (beside GNU make, see above for info on that).
- rsync
Before you are able to publish to anything, you have to define targets as environment variables. By default, it will do nothing at all. You need to define a couple of target variables. These targets can be a location on your own file system, or it can be any remote protocol that rsync supports (like SSH).
ld38_remote_productionis the environment variable for the production remote.export ld38_remote_production=user@domain.tld:path/to/hosting
ld38_remote_developmentis the environment variable for the development remoteexport ld38_remote_development=user@domain.tld:path/to/hosting
If you want to deal with the composer or bower dependencies, which may be necessary for certain development operations (namely updating them or adding new ones), you will need the following in addition to all of these. Note that not all of the dependencies are being managed with these tools, and as such, some dependency updates may require manual updating.
- Composer
- Bower
Just a webserver that can serve static files. That can be anything you want. It probably won't work if you open the files locally though, because of browser security standards.