KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

FAT

★ 84 Open GitHub ↗

FAT - Frame Data App (SF, GGST)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FAT
Welcome to FAT! The most popular SF6, GGST, and 2XKO frame data app in the world! You can check out live versions of the app here:

[Webapp](https://fullmeter.com/fatonline)

[Mobile App](https://fullmeter.com/fat)

## Contributing to FAT

### Developing
If you'd like to contribute to FAT, please open an issue about what you're interested in doing. I won't accept a pull request without an issue, so don't waste your time. You can also discuss it with me in our [discord channel](https://discord.gg/BfrCaHKU5J)

### Frame Data & General data corrections
Frame Data corrections need to be fixed via our team's spreadsheet. We don't directly edit the JSON file. Please report any and all frame data mistakes in our [discord channel](https://discord.gg/9BK8hHS). The same goes for the Combos & Moveslist section.

## Reusing FAT source code
For more details, you can read the license but essentially anything you make with FAT's source code
- must be open source as well
- must link to this repository in your own repository
- must visibly credit FAT in the final product

## Developing for FAT
FAT is an Ionic React app built with Capacitor. You'll need npm to get going and then

### Setup
```
npm install
```
You'll need the Ionic CLI
```
npm install -g @ionic/cli
```

### Run
To run the project in your browser do
```
ionic serve
```
To build the project with Capacitor do
```
ionic build

// android or ios
ionic cap sync android
```
To open the project in Android Studio you can do
```
ionic cap open android
```
This requires you to point Capacitor at the location of your Android Studio installation. You can set this up by adding/editing local.properties in ./android. For example
```
sdk.dir=/home/you/location/of/Android/Sdk
```

## Deployment
Add a new version log and bump the 3 constants at the top of the page to the correct values in ```src/js/constants/VersionLogs.js```. Also adjust the FrameData and GameDetails codes as required.

If previously remote fetched characters have been moved to the local build, be sure to remove their remoteImage Boolean from the sheet

Because it's Capacitor, you'll need to build for iOS and Android in XCode and Studio respectively.

Alternatively you can deploy the apps using fastlane, as laid out below

Deploying to the web is just a matter of setting the homepage with the following command
```
ionic build --prod --public-url=/fatonline
```
or running `npm run web:release`

### iOS App Store

> Deployment of the iOS app can only be done by the core developers who have access to the team's Apple Developer account

Deployment of release builds on iOS is done using [Fastlane](https://fastlane.tools). To use this, you will need to follow [Fastlane's setup docs](https://docs.fastlane.tools/getting-started/ios/setup/). Once you've done this, follow these steps to get set up:

- Copy `ios/App/fastlane/.env.sample` to `ios/App/fastlane/.env` and replace it with the actual values from the Apple Developer site
- Download the existing metadata with `fastlane deliver download_metadata`
- Download the existing screenshots with `fastlane deliver download_screenshots --use_live_version true`
- If that doesn't work, try `fastlane deliver download_metadata --use_live_version true --api_key_path ./fastlane/AuthKey_KEY_ID.json`

Once you have all this set up, you can release a new version:

- Increase the version number in Xcode
- Update the changelog in `ios/App/fastlane/metadata/en-US/release_notes.txt`
- Run `npm run ios:release`

### Google Play Store

> Deployment of the Google Play app can only be done by the core developers who have access to the team's Google Developer account

Deployment of release builds on Google Play is done using [Fastlane](https://fastlane.tools). To use this, you will need to follow [Fastlane's setup docs](https://docs.fastlane.tools/getting-started/android/setup/). Once you've done this, follow these steps to get set up:

- Copy `android/fastlane/.env.sample` to `android/fastlane/.env` and replace it with the actual values from the Google Developer site etc.
- Download the metadata with `bundle exec fastlane supply init`

Once you have all this set up, you can release a new version:

- Bump the versionCode and versionName in `android/app/build.gradle`
- Update the changelog in `android/fastlane/metadata/android/en-GB/changelogs/VERSIONNUMBER.txt`
- Run `npm run android:release`

## Adding a new game

General Changes
- Set up the Frame Data in `src/js/constants/framedata/NameFrameData.json`
- Set up the Game Details in `src/js/constants/gamedetails/NameGameDetails.json`
- Update `src/js/constants/gamedetails/characterLists.ts` with the required items
- Exclude the game from any menu items you need to in `src/js/components/Menu.tsx` and `src/js/components/MenuEntry.tsx`
- Add to type array in `src/js/constants/ImmutableGameDetails.ts`
- Add to array in `src/js/components/CharacterEntryDetailed.tsx`
- Add search result layout obj in `src/js/pages/QuickSearch.tsx`
- Deal with any CH buttons you want handled on `src/js/pages/FrameData.tsx`

Updatable Game (if the game is going to receive server updates)
- Add to the UDPATABLE_GAMES and UPDATABLE_GAMES_APP_CODES obj in `src/js/constants/VersionLogs.ts`
- Create the correct file structure on your server as follows:
  - `release/GAME_NAME/FrameData/GAMENAMEFrameData.json`
  - `release/GAME_NAME/FrameData/GAMENAMEFrameDataVersionDetails.json`
  - `release/GAME_NAME/GameDetails/GAMENAMEGameDetails.json`
  - `release/GAME_NAME/GameDetails/GAMENAMEGameDetailsVersionDetails.json`

Changes to `./src/js/actions/index.ts`
- Import the framedataJSON
- Dispatch the frame data in getFrameData()
- If the game requires state switchers (like VT) amend setPlayer()
- Import the gamedetailsJSON
- Dispatch the game details in getGameDetails()

FAT

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README