Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.82 KB

Contributing to Swift Space Battle

Thanks for taking your time to contribute in this game! 👍

The game development it's using MOAI engine and Lua language.

Check the issues tab to look for improvements reported.

Feel free to report one or just work on something not listed.

Setup your development

If you would like to run the game locally, you will need to setup your environment.

Don't worry on installation of tools, their installation are automated in a single tool.

Follow this guide to download and read a simple documentation: MoaiCLI.

Note that the command moaicli will be available when exporting the executable, which will depend on your Operating System (have a look here for Windows and Linux)

When you run your first build this will download and setup all the tools required.

To run the HTML version you will also need Node.js, this one is for running your game through a HTTPS page.

After installing the tools and building the debug version of the game for HTML, run this command:

node distribute/html/html-debug/app.js

Note that the page will have a default design, generated by MoaiCLI.

You can download the web files in gh-pages to see the same page as in https://luanorlandi.github.io/Swift-Space-Battle/.