Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 4.53 KB

CONTRIBUTING.md

File metadata and controls

113 lines (77 loc) · 4.53 KB
Raw

Contributing to Journey to the Center of Hawkthorne

What the heck to work on

You're looking to help? Great, we're looking for help! You can help out in variety of ways.

  • Code new game features
  • Record music and sound effects
  • Draw sprites and tile sets
  • Create new costumes and characters
  • Play test the game and find bugs

Music and sound effects

We always need help with new sounds. Take a look at the list of needed music and sound effects and pick an item to work on. Make sure to comment on the issue once you've decided to work on it. Once you're finished, post a link to your completed audio file in the issue and we'll get it into the game.

Please submit your audio files as uncompressed wavs. While hosting isn't important, we like to use Sound Cloud.

Sprites

There are always new sprites that we need made. Take a gander at the list of needed sprites and pick an item to work on. Make sure to comment on the issue once you've decided to work on it. Once you're finished, post a link to your completed sprite file in the issue and we'll get it into the game.

Would you rather work on organizing sprites? We need people to take existing sprites and organize them into a tileset so that we can make a level. Pick from a tileset we need made and get to work.

Note: the deprecated sprite/sound/character spreadsheet

Code

We love pull requests. Here's a quick guide:

  1. Choose a gameplay feature or bug to work on. Comment on the issue so that we know you are working on it.

  2. Fork the repo. Please also create a separate branch

    $ git checkout -b my-cool-feature

    We don't accept pull requests from master branches.

  3. Make sure the game runs with your change. See the README for details.

  4. Push to your fork and submit a pull request.

At this point you're waiting on us. We like to at least comment on, if not accept, pull requests within a few days. We may suggest some changes or improvements or alternatives.

Write unit tests

We value testing above all else. To run the unit tests, run

$ make test

in the repository.

Some things that will increase the chance that your pull request is accepted

  • Use Lua idioms and helpers
  • Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution

Syntax:

  • Two spaces, no tabs.
  • No trailing whitespace. Blank lines should not have any space.
  • Follow the conventions you see used in the source already.

Handy Code Templates:

Node Template: used for making objects in the game

Gamestate Template: used for making a new gamescreen(e.g the pause menu)

Characters and Costumes

First, read the costume creation guide or character creation guide. These guides give you all the information you'll need to get started.

When you're finished, either open an issue on Github or create a post on the /r/hawkthorne subreddit.

Playtest

Playtesters are always needed. Download the game and follow the walthrough. Make sure to report any bugs you find. Please include your operating system and computer specs when reporting an issue.