Skip to content

Commit

Permalink
update readme to reflect work in progress
Browse files Browse the repository at this point in the history
  • Loading branch information
mk360 committed Oct 16, 2024
1 parent 8b07a7e commit e4c3182
Showing 1 changed file with 1 addition and 32 deletions.
33 changes: 1 addition & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1 @@
<h1>Fire Emblem Heroes - Phaser 3</h1>

This is an attempt to recreate Fire Emblem Heroes, with the help of the <a href="https://github.com/photonstorm/phaser">Phaser</a> Framework.

<h2>Scope</h2>
<ul>
<li>Turn-to-turn movement management.</li>
<li>Attacks, with the appropriate animations and UI.</li>
<li>As-faithful-as-possible UI recreation<a href="#notes">*</a>.</li>
<li>Basic skills and weapon effects.</li>
</ul>

<h2 id="notes">Notes</h2>
I did my best to create a UI (and game in general) that's as accurate as possible, however I'm probably not going to reach a perfect imitation anytime soon. A few reasons why:
<ul>
<li>IntSys uses assets that don't match 100% with the way they're used in-game. There are a few elements I couldn't find or recreate.</li>
<li>FEH stores animation files (characters in their idle stance, damaged, etc.) in a proprietary format, and I'm not really keen on implementing them. That might change in the future, but for now I'll stick with static images for the sake of simplicity.</li>
<li>I wanted to be as vertical as possible with the game's code. A rewrite is planned, although I need to finish the "v1" first.</li>
</ul>

<h2>Want to lend a hand?</h2>

Hit me up by adding me (N_tonio36#5530) on Discord.

<h2>Credits and thanks</h2>
<ul>
<li><a href="https://github.com/photonstorm">Richard Davey / Photonstorm</a> for creating the framework.</li>
<li><a href="https://github.com/yandeu">Yannick Deubel</a> for creating this production-ready template.</li>
</ul>

<h2>License</h2>
MIT License, see <a href="https://github.com/mk360/feh/blob/master/LICENSE">the LICENSE file</a> for more details.
This repo is currently going through a rework. Please check the `integration` branch.

0 comments on commit e4c3182

Please sign in to comment.