# atox07/fnf-super-plus-engine architecture

> Architecture diagram of the GitHub repository atox07/fnf-super-plus-engine, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/atox07/fnf-super-plus-engine
- Repository: https://github.com/atox07/fnf-super-plus-engine

## Overview

Super Plus Engine is a Friday Night Funkin’ rhythm-game engine fork with an Android launcher and game content. The principal player workflow is to start the game, choose songs or weeks, and play charts alongside music and character/stage presentation. The README also identifies inherited Psych Engine features, NotITG modchart support, compatible hxcodec videos, and backwards-compatibility tools. The tree shows corresponding source and asset areas, but gameplay implementation was not sampled; those connections are therefore left unverified. The Android launcher and Linux GameMode client are represented from their excerpts.

Main entry points: [`source/states/play`](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/states/play) (Song Play), [`source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt`](https://github.com/atox07/fnf-super-plus-engine/blob/main/source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt) (Launcher UI), [`source/states`](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/states) (Week Selection), [`source/objects/hxcodec`](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/objects/hxcodec) (hxcodec Playback)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_launcher["Android Launcher"]
  node_launcher["Launcher UI"]
  node_permissions["Permissions and Files"]
  node_updater["Release Updater"]
  node_main_activity["Game Activity"]
end

subgraph group_gameplay["Rhythm Gameplay"]
  node_week_select["Week Selection"]
  node_song_play["Song Play"]
  node_chart_editor["Chart Editor"]
  node_modchart["Modchart Support"]
end

subgraph group_content["Game Content"]
  node_song_charts["Song Charts"]
  node_week_data["Week Data"]
  node_music["Song Audio"]
  node_characters["Characters and Stages"]
  node_videos["Cutscene Videos"]
end

subgraph group_extensions["Engine Extensions"]
  node_video_playback["hxcodec Playback"]
  node_scripting["Lua and HScript"]
  node_compatibility["Compatibility Tools"]
  node_gamemode_client["GameMode Client<br/>[gamemode_client.h]"]
end

node_player(("Player"))
node_release_service["GitHub Releases"]
node_gamemode_library["Linux GameMode"]

node_player -->|"opens"| node_launcher
node_launcher -->|"displays and requests"| node_permissions
node_launcher -->|"checks updates"| node_updater
node_updater -->|"queries releases"| node_release_service
node_launcher -->|"starts game"| node_main_activity
node_player -.->|"chooses week"| node_week_select
node_week_select -.->|"starts song"| node_song_play
node_song_play -.->|"loads charts"| node_song_charts
node_week_select -.->|"uses week data"| node_week_data
node_song_play -.->|"plays audio"| node_music
node_song_play -.->|"presents stages"| node_characters
node_song_play -.->|"supports modifiers"| node_modchart
node_player -.->|"edits charts"| node_chart_editor
node_song_play -.->|"supports scripting"| node_scripting
node_song_play -.->|"supports compatible videos"| node_video_playback
node_video_playback -.->|"plays cutscenes"| node_videos
node_song_play -.->|"uses compatibility tools"| node_compatibility
node_gamemode_client -->|"loads symbols"| node_gamemode_library

click node_launcher "https://github.com/atox07/fnf-super-plus-engine/blob/main/source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt"
click node_permissions "https://github.com/atox07/fnf-super-plus-engine/blob/main/source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt"
click node_updater "https://github.com/atox07/fnf-super-plus-engine/blob/main/source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt"
click node_main_activity "https://github.com/atox07/fnf-super-plus-engine/tree/main/source/mobile"
click node_week_select "https://github.com/atox07/fnf-super-plus-engine/tree/main/source/states"
click node_song_play "https://github.com/atox07/fnf-super-plus-engine/tree/main/source/states/play"
click node_chart_editor "https://github.com/atox07/fnf-super-plus-engine/tree/main/source/states/editors"
click node_modchart "https://github.com/atox07/fnf-super-plus-engine/tree/main/source/modchart"
click node_song_charts "https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/shared/data"
click node_week_data "https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/shared/weeks"
click node_music "https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/songs"
click node_characters "https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/shared/characters"
click node_videos "https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/videos"
click node_video_playback "https://github.com/atox07/fnf-super-plus-engine/tree/main/source/objects/hxcodec"
click node_scripting "https://github.com/atox07/fnf-super-plus-engine/tree/main/source/psychlua"
click node_compatibility "https://github.com/atox07/fnf-super-plus-engine/tree/main/source"
click node_gamemode_client "https://github.com/atox07/fnf-super-plus-engine/blob/main/source/external/gamemode_client.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_launcher,node_permissions,node_updater,node_main_activity toneBlue
class node_week_select,node_song_play,node_chart_editor,node_modchart toneAmber
class node_song_charts,node_week_data,node_music,node_characters,node_videos toneMint
class node_video_playback,node_scripting,node_compatibility,node_gamemode_client toneRose
class node_player,node_release_service,node_gamemode_library toneIndigo
```

## Components

### Android Launcher

- [Launcher UI](https://github.com/atox07/fnf-super-plus-engine/blob/main/source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt): `source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt`
- [Permissions and Files](https://github.com/atox07/fnf-super-plus-engine/blob/main/source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt): `source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt`
- [Release Updater](https://github.com/atox07/fnf-super-plus-engine/blob/main/source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt): `source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt`
- [Game Activity](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/mobile): `source/mobile`

### Rhythm Gameplay

- [Week Selection](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/states): `source/states`
- [Song Play](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/states/play): `source/states/play`
- [Chart Editor](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/states/editors): `source/states/editors`
- [Modchart Support](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/modchart): `source/modchart`

### Game Content

- [Song Charts](https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/shared/data): `assets/base_game/shared/data`
- [Week Data](https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/shared/weeks): `assets/base_game/shared/weeks`
- [Song Audio](https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/songs): `assets/base_game/songs`
- [Characters and Stages](https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/shared/characters): `assets/base_game/shared/characters`
- [Cutscene Videos](https://github.com/atox07/fnf-super-plus-engine/tree/main/assets/base_game/videos): `assets/base_game/videos`

### Engine Extensions

- [hxcodec Playback](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/objects/hxcodec): `source/objects/hxcodec`
- [Lua and HScript](https://github.com/atox07/fnf-super-plus-engine/tree/main/source/psychlua): `source/psychlua`
- [Compatibility Tools](https://github.com/atox07/fnf-super-plus-engine/tree/main/source): `source`
- [GameMode Client](https://github.com/atox07/fnf-super-plus-engine/blob/main/source/external/gamemode_client.h): `source/external/gamemode_client.h`

### Other components

- **Player**
- **GitHub Releases**
- **Linux GameMode**

## Connections

- Player → Launcher UI: opens (evidence: `source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt`)
- Launcher UI → Permissions and Files: displays and requests (evidence: `source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt`)
- Launcher UI → Release Updater: checks updates (evidence: `source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt`)
- Release Updater → GitHub Releases: queries releases (evidence: `source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt`)
- Launcher UI → Game Activity: starts game (evidence: `source/mobile/android/app/src/main/kotlin/engine/launcher/EngineLauncherActivity.kt`)
- Player → Week Selection: chooses week
- Week Selection → Song Play: starts song
- Song Play → Song Charts: loads charts
- Week Selection → Week Data: uses week data
- Song Play → Song Audio: plays audio
- Song Play → Characters and Stages: presents stages
- Song Play → Modchart Support: supports modifiers (evidence: `README.md`)
- Player → Chart Editor: edits charts
- Song Play → Lua and HScript: supports scripting
- Song Play → hxcodec Playback: supports compatible videos (evidence: `README.md`)
- hxcodec Playback → Cutscene Videos: plays cutscenes
- Song Play → Compatibility Tools: uses compatibility tools (evidence: `README.md`)
- GameMode Client → Linux GameMode: loads symbols (evidence: `source/external/gamemode_client.h`)
