Home

Welcome to the Golden Sun HTML5 wiki!

GSHTML5 is an engine to build games like Golden Sun 1 and 2. It's 100% open source and free (MIT licensed). Build a GS-like game without programming/hack skills.

Check the README section to see general info about the project.

Introduction for users

Once you downloaded the latest version here, extract the zip file and go to the extracted directory. In order to start the engine, just execute gshtml5.exe.

The engine content is totally controlled by what is inside resources/app/assets directory. Here you'll find tilesets, spritesheets, BGMs, SFXs, maps, and database info. On database files, you will define items, chars, NPCs, Interactable Objects, djinn, summons, etc. Any modification in this directory will automatically be reflected in the game after at least a single restart. Most of the engine data is organized through JSON files, if you're not comfortable with it, please check this tutorial What's a JSON file, it's simple.

When you download gshtml5, it already comes with the demo that's available online. Feel free to remove and keep what is relevant to your project. Please also modify as needed some initialization settings, like hero initial position, initial map, keyboard inputs, etc, you can check these settings here.

In order to start editing the assets to create your game, please follow some tutorials:

• Creating spritesheets with Texture Packer or Free texture packer
• Creating a simple map
• Adding NPCs to the map
• Adding Interactable Objects to the map
• Special NPCs
• Random battles
• Animated Tiles
• Interactable Objects summary

Helpful tips for debugging your game

• Press G to enable grid mode (useful to check events position and tile numbers).
• Press D to enable collision structures debug mode.
• Find log files in gshtml5-win32-x64/resources/app/logs to check user input error.
• Press 1, 2, 3, or 4 keyboard keys to change screen size.