Journey to the Center of Hawkthorne

This 2d platformer is based on Community's Digital Estate Planning episode. It's built using the LÖVE game engine. Please report any issues or bugs you have with the game!

Downloads ( play the game )

If you already have love installed, you can download the server and client files and run the game from there.

Linux users: Install LÖVE. You'll need at least version 0.8.0. (Standard Ubuntu packages are too old.) After installing LÖVE, download the server file and run it, then download the client file and run it. Everyone gets to play!

Development ( contribute to the game )

All discussion and development takes place on /r/hawkthorne. If you have any contributions you'd like to submit, either open a pull request or create a post on the subreddit.

Getting your build up and running

Create a free GitHub account - https://github.com/plans
Set up Git on your machine - https://help.github.com/articles/set-up-git
Fork https://github.com/NimbusBP1729/hawkthorne-server-lua ( click the 'fork' button at the top of this page )
Fork https://github.com/NimbusBP1729/hawkthorne-client-lua
Follow the machine specific instructions below

OSX

Be sure to complete the steps above to get started
Install the most recent version of LÖVE - http://love2d.org
Open Terminal

Make a command line alias to love

 $ alias love='/Applications/love.app/Contents/MacOS/love'

Add the alias to ~/.bash_profile so it works the next time you reboot

 $ echo alias love='/Applications/love.app/Contents/MacOS/love' >> ~/.bash_profile

Download and install the latest version of tmx2lua

 $ curl -OL https://github.com/downloads/kyleconroy/tmx2lua/tmx2lua.osx.tar
 $ tar -xf tmx2lua.osx.tar
 $ sudo cp tmx2lua /usr/bin/tmx2lua

Clone your newly forked server repository and change directory Note: You have to copy your repository url from github ( ex: https://github.com/username/hawkthorne-server-lua.git )
```
 $ git clone (your forked repository url)
 $ cd hawkthorne-server-lua
```
Build your maps ( this must be done each time you change a map )
```
 $ make maps
```
Run the server
```
 $ love src
```
A black screen indicates success!

If you are testing a specific port, you can optionally pass that port using the --port option
```
 $ love src --port=12345
```
You can also test a specific address and port
```
 $ love src --port=12345 --address="localhost"
```
Clone your newly forked client repository and (in another terminal) change directory Note: You have to copy your repository url from github ( ex: https://github.com/username/hawkthorne-server-lua.git )
```
 $ git clone (your forked repository url)
 $ cd hawkthorne-client-lua
```
Build your maps ( this must be done each time you change a map )
```
 $ make maps
```
Run the server
```
 $ love src
```
A blue error message screen indicates the address was found, but we failed to establish a connection. Seeing the top of a map currently isn't an indication of the ability to connect.

If you are testing a specific port, you can optionally pass that port using the --port option
```
 $ love src --port=12345
```

OpenAL Issues

Some older versions of OS X have a broken version of OpenAL. If you find the game crashing after a few minutes of play, you'll need to download a different version of the Love2D framework which uses OpenAL soft. You can download this alternate version here

Linux

Be sure to complete the steps above to get started
Install the most recent version of LÖVE - http://love2d.org

NOTE: Many package managers have a very old version of love. Make sure that you have at least v0.8.0 or the game will not launch
Open Terminal

Download the latest version of tmx2lua

Linux 64-bit:

 $ wget https://github.com/downloads/kyleconroy/tmx2lua/tmx2lua.linux64.tar

Linux 32-bit:

 $ wget https://github.com/downloads/kyleconroy/tmx2lua/tmx2lua.linux.tar

Install tmx2lua

 $ tar -xf tmx2lua.linux*.tar
 $ sudo cp tmx2lua /usr/bin/tmx2lua

Clone your newly forked server repository and change directory Note: You have to copy your repository url from github ( ex: https://github.com/username/hawkthorne-server-lua.git )
```
 $ git clone (your forked repository url)
 $ cd hawkthorne-server-lua
```
Build your maps ( this must be done each time you change a map )
```
 $ make maps
```
Run the server
```
 $ love src
```
A black screen indicates success!

If you are testing a specific port, you can optionally pass that port using the --port option
```
 $ love src --port=12345
```
You can also test a specific address and port
```
 $ love src --port=12345 --address="localhost"
```
Clone your newly forked client repository and (in another terminal) change directory Note: You have to copy your repository url from github ( ex: https://github.com/username/hawkthorne-server-lua.git )
```
 $ git clone (your forked repository url)
 $ cd hawkthorne-client-lua
```
Build your maps ( this must be done each time you change a map )
```
 $ make maps
```
Run the server
```
 $ love src
```
A blue error message screen indicates the address was found, but we failed to establish a connection. Seeing the top of a map currently isn't an indication of the ability to connect.

If you are testing a specific port, you can optionally pass that port using the --port option
```
 $ love src --port=12345
```

Windows

Be sure to complete the steps above to get started
Install the most recent version of LÖVE - http://love2d.org

a) add the love directory to the path
```
 $ set Path=%Path%;(love directory)
```
OR

a) navigate to "Control Panel > System"

b) click "Advanced system settings"

c) in the "Advanced" tab click the "Environment Variables" button

d) add the following to the path ";(love directory)"
Download the tmx converter:

a) download and unzip the tmx2lua file for your system

32 bit: https://github.com/downloads/kyleconroy/tmx2lua/tmx2lua.windows32.zip

or

64 bit: https://github.com/downloads/kyleconroy/tmx2lua/tmx2lua.windows64.zip

b) move tmx2lua to your "hawkthorne-journey" directory
```
 $ mv (tmx directory)/tmx2lua.windows64 hawkthorne-journey/
```
Clone your newly forked server repository and change directory Note: You have to copy your repository url from github ( ex: https://github.com/username/hawkthorne-server-lua.git )
```
 $ git clone (your forked repository url)
 $ cd hawkthorne-server-lua
```
Build your maps ( this must be done each time you change a map )
```
 $ make maps
```
Run the server
```
 $ love src
```
A black screen indicates success!

If you are testing a specific port, you can optionally pass that port using the --port option
```
 $ love src --port=12345
```
You can also test a specific address and port
```
 $ love src --port=12345 --address="localhost"
```
Clone your newly forked client repository and (in another terminal) change directory Note: You have to copy your repository url from github ( ex: https://github.com/username/hawkthorne-server-lua.git )
```
 $ git clone (your forked repository url)
 $ cd hawkthorne-client-lua
```
Build your maps ( this must be done each time you change a map )
```
 $ make maps
```
Run the server
```
 $ love src
```
A blue error message screen indicates the address was found, but we failed to establish a connection. Seeing the top of a map currently isn't an indication of the ability to connect.

If you are testing a specific port, you can optionally pass that port using the --port option
```
 $ love src --port=12345
```

Notes:

    $ make && love src

will only build necessary maps and then run the executable.

ii)

    $ love src --console

will additionally launch a handy console for print statements

License

Unless otherwise noted, this code is licensed under the MIT License.

Artwork and audio files are licensed under CC BY-NC 3.0. Artwork includes all .png, .psd, .ogg, and .wav files.

dyher/hawkthorne-server-lua