README.md

Golden Sun Engine - HTML5

An Golden Sun Engine entirely built in HTML5 with PhaserJS CE 2.19.0.

See the DEMO. Use Chromium based browsers. Don't use Firefox.

• With this project, people should be able to make a GS like game without any programming skills.
• This repository is just the engine. I'm not planning to do many maps, animations, items etc. Content here is just enough to show the functionalities.
• This project does not aim to do exactly the same engine as GS, but very similar.
• WE NEED HELP! Please, feel free to reach me if you want to do so. Join our discord server.
• If you found any bug, please create an issue for it.
• Issues are not very well explained, feel free to reach me for details about them.
• Check the wiki for database configuration, tutorials and project tech information.
• This project deployment is a desktop application.
• Check the latest updates.

Development environment

GS-HTML5 supports both Javascript (legacy) and Typescript. We use Webpack to build the bundle and serve the development environment.

• I strongly recomend using Visual Studio Code to develop.
• Install dev dependencies by running npm install in the root folder.
• Use npm start to start the development server.
• Check the general guidelines in order to contribute.
• Learn Phaser 2 by examples or by this tutorial. For reference, check their API.
• Check our API docs for quick reference.

Utils

Some useful tools that I use to manage the resources:

• Visual Studio Code (for developing the game)
• Tiledmap Editor
• Golden Sun Editor (for game info and media)
• TexturePacker 4.6.1 (for creating spritesheets)
  • Free texture packer (free alternative for TexturePacker)
  • Sprite Sheet Packer (free alternative for TexturePacker)

Minor utils

• Shoebox (for creating fonts)
• Paint.NET (for images editing)
• XnConvert (for batch image convertion)
• Format Factory (for converting audio files)
• Audacity (for editing audio files)
• ScreenToGif (for creating gifs and reporting bugs)

Credits

• http://www.goldensunhacking.net/ (This project would be impossible without these guys)
• https://gamefaqs.gamespot.com/gba/561356-golden-sun-the-lost-age/faqs
• http://www.goldensun-syndicate.net/sprites/
• https://www.spriters-resource.com/game_boy_advance/gs/
• https://www.spriters-resource.com/game_boy_advance/gs2/
• Golden Sun is copyright 2001-2003 Nintendo / CAMELOT.

All Golden Sun games and their media are property of Camelot Software Planning Ltd., Nintendo and/or Nintendo of America Inc., and are protected by United States and international copyright, trademark and other intellectual property laws.