Home Explore Help
Register Sign In
jorgesumle
/
hexoshi
Watch 1
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
hexoshi
/
CONTRIBUTING

CONTRIBUTING 1.9 KB
Permalink History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 
  1. This file has been dedicated to the public domain, to the extent
    2. 

  2. possible under applicable law, via CC0. See
    3. 

  3. http://creativecommons.org/publicdomain/zero/1.0/ for more
    4. 

  4. information. This file is offered as-is, without any warranty.
    5. 

  5. 

  6. ========================================================================
    7. 

  7. 

  8. 

  9. Any contributions to this project should be based on the latest revision
    10. 

  10. found in the Git repository. This repository can be found here:
    11. 

  11. 

  12. https://savannah.nongnu.org/git/?group=hexoshi
    13. 

  13. 

  14. This document is designed to help you understand how to make changes,
    15. 

  15. how to run the version of the game from the repo, and how to forward
    16. 

  16. your changes upstream.
    17. 

  17. 

  18. 

  19. MAKING CHANGES
    20. 

  20. 

  21. To make changes to the main game program, simply edit "hexoshi.py".  If
    22. 

  22. you like, you can add your own copyright notice to the top of the file.
    23. 

  23. 

  24. To add any sort of game data, place it in the appropriate section of the
    25. 

  25. "data" directory, and add licensing information to "data/LICENSES".
    26. 

  26. Note: Any data contribution which is not given a proper libre license
    27. 

  27. WILL BE REJECTED.  Please adhere to the formatting of the rest of the
    28. 

  28. entries in the LICENSES file as closely as possible.
    29. 

  29. 

  30. Whatever your contributions, please ensure that you add your name to
    31. 

  31. data/credits.json in the appropriate section(s). Make sure to test your
    32. 

  32. modification of this file with the "Credits" option from the main menu
    33. 

  33. of the game.
    34. 

  34. 

  35. 

  36. RUNNING THE GAME
    37. 

  37. 

  38. Running the version of the game from the repo is similar to running the
    39. 

  39. source code releases, but the main difference is that dependencies are
    40. 

  40. not included.  The main dependencies are:
    41. 

  41. 

  42. - SGE Game Engine - http://stellarengine.nongnu.org
    43. 

  43. - xSGE - http://xsge.nongnu.org
    44. 

  44. - Six - https://pypi.python.org/pypi/six
    45. 

  45. 

  46. Of course, all dependencies of these libraries must also be installed.
    47. 

  47. 

  48. 

  49. FORWARDING YOUR CHANGES
    50. 

  50. 

  51. To forward your changes, please clone the Git repo, push it to your own
    52. 

  52. Git repo (any Git service will do), and send me a link to your repo.
    53. 

  53.