No description, website, or topics provided.
Lua
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
LICENSE
README.md
armor.lua
character.lua
charmap.lua
final_fantasy.lua
magic.lua
main.glade
orb.svg
weapon.lua

README.md

ff_companion

This is a lua script for fceux that provides and object-oriented view into the Final Fantasy game.

Requirements

This script requires both FCEUX, a Final Fantasy rom, and lua-lgi.

FCEUX can be grabbed from http://www.fceux.com/, or more easily on Linux from your favorite distribution's package manager.

Getting a Final Fantasy rom is a task left for the reader to figure out.

lua-lgi can be grabbed from https://github.com/pavouk/lgi, or more easily on Linux from your favorite distribution's package manager.

The Interface

A GTK interface exposes some information about the game. The current interface is primarily for debugging only and will look drastically different when complete.

Goals

The following goals are in order of precedence.

  1. Create classes for the most relevant objects in the game. e.g. Characters, armor, weapons, magic, enemies, etc.
  2. Create a screen that shows information about all characters, the current game state, etc.
  3. Provide an alternate interface that can essentially replace the actual interface, but looks better, and provides a better UX.