https://github.com/jjppof/goldensun_html5
An online Golden Sun Engine entirely built in HTML5 with Phaser 2. Check https://gshtml5.org/
https://github.com/jjppof/goldensun_html5
game game-2d game-engine golden-sun gshtml5 hacktoberfest phaserjs
Last synced: 6 months ago
JSON representation
An online Golden Sun Engine entirely built in HTML5 with Phaser 2. Check https://gshtml5.org/
- Host: GitHub
- URL: https://github.com/jjppof/goldensun_html5
- Owner: jjppof
- License: mit
- Created: 2017-01-07T14:24:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-31T15:17:46.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T00:43:23.816Z (over 1 year ago)
- Topics: game, game-2d, game-engine, golden-sun, gshtml5, hacktoberfest, phaserjs
- Language: JavaScript
- Homepage: https://gshtml5.org/
- Size: 52 MB
- Stars: 169
- Watchers: 8
- Forks: 39
- Open Issues: 67
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Golden Sun Engine - HTML5
An **Golden Sun Engine** entirely built in HTML5 with [PhaserJS CE 2.19.0](http://phaser.io/).
**See the [DEMO](https://jjppof.github.io/goldensun_html5/index).** 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 out to me if you want to do so. Join our [**discord server**](https://discord.gg/fYFSxPMjmS).
- If you found any bug, please create an [issue](https://github.com/jjppof/goldensun_html5/issues/new) for it.
- Issues are not very well explained. Feel free to reach out to me for details about them.
- Check the [wiki](https://github.com/jjppof/goldensun_html5/wiki) for database configuration, tutorials and project tech information.
- This project deployment is a desktop application.
- Check the [latest updates](https://github.com/jjppof/goldensun_html5/discussions/categories/updates).
## Development environment
GS-HTML5 supports both Javascript (legacy) and Typescript. We use [Webpack](https://webpack.js.org/) to build the bundle and serve the development environment.
- I strongly recommend using [Visual Studio Code](https://code.visualstudio.com/download) to develop.
- Install dev dependencies by running `npm install --legacy-peer-deps` in the root folder.
- Use `npm start` to start the development server.
- Check the [general guidelines](https://github.com/jjppof/goldensun_html5/wiki/Introduction-for-developers#some-coding-guidelines) in order to contribute.
- Learn Phaser 2 by [examples](https://phaser.io/examples/v2) or by this [tutorial](https://phaser.io/tutorials/making-your-first-phaser-2-game). For reference, check their [API](https://photonstorm.github.io/phaser-ce/index.html).
- Check our [API docs](https://gshtml5.org/docs/) for quick reference.
## Utils
Some useful tools that I use to manage the resources:
- [Visual Studio Code](https://code.visualstudio.com/download) (for developing the game)
- [Tiledmap Editor](https://www.mapeditor.org/)
- [Golden Sun Editor](https://drive.google.com/file/d/1NafC8KpM1VJ21o6IqRg3WrpU4ur7NwbN/view?usp=sharing) (for game info and media)
- [TexturePacker 4.6.1](https://www.codeandweb.com/texturepacker) (for creating spritesheets)
- [Free texture packer](http://free-tex-packer.com/) (free alternative for TexturePacker)
- [Sprite Sheet Packer](https://www.codeandweb.com/free-sprite-sheet-packer) (free alternative for TexturePacker)
#### Minor utils
- [Shoebox](https://renderhjs.net/shoebox/) (for creating fonts)
- [Paint.NET](https://www.getpaint.net/) (for images editing)
- [XnConvert](https://www.xnview.com/en/xnconvert/) (for batch image convertion)
- [Format Factory](http://www.pcfreetime.com/formatfactory/index.php) (for converting audio files)
- [Audacity](https://www.audacityteam.org/) (for editing audio files)
- [ScreenToGif](https://www.screentogif.com/) (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.