# Friday Night Funkin'

## Docs

- [Assets](https://mintlify.wiki/FunkinCrew/Funkin/api/assets.md): Asset loading and management wrapper around OpenFL's asset system
- [FunkinSound](https://mintlify.wiki/FunkinCrew/Funkin/api/audio/funkin-sound.md): Extended FlxSound with delayed playback, pooling, and enhanced audio management
- [Audio Visualization](https://mintlify.wiki/FunkinCrew/Funkin/api/audio/visualize.md): Real-time audio visualization system with waveforms, spectrograms, and FFT analysis
- [VoicesGroup](https://mintlify.wiki/FunkinCrew/Funkin/api/audio/voices-group.md): Specialized sound group for managing separate player and opponent vocal tracks
- [Conductor](https://mintlify.wiki/FunkinCrew/Funkin/api/conductor.md): Core class that handles musical timing throughout the game
- [CharacterData](https://mintlify.wiki/FunkinCrew/Funkin/api/data/character-data.md): Character data structure and rendering configuration
- [SongData](https://mintlify.wiki/FunkinCrew/Funkin/api/data/song-data.md): Song metadata, chart, and music data structures
- [StageData](https://mintlify.wiki/FunkinCrew/Funkin/api/data/stage-data.md): Stage configuration, props, and character positioning
- [Module System](https://mintlify.wiki/FunkinCrew/Funkin/api/modding/module.md): Create persistent scripted mods that respond to game events across all states
- [PolymodHandler](https://mintlify.wiki/FunkinCrew/Funkin/api/modding/polymod-handler.md): Core modding handler that manages mod loading, initialization, and asset management
- [IScriptedClass](https://mintlify.wiki/FunkinCrew/Funkin/api/modding/scripted-class.md): Interface definitions for creating scripted classes that respond to game events
- [BaseCharacter](https://mintlify.wiki/FunkinCrew/Funkin/api/play/character.md): Character system for playable and opponent characters
- [Song Events](https://mintlify.wiki/FunkinCrew/Funkin/api/play/events.md): Song event system for dynamic gameplay changes
- [Notes & Strumline](https://mintlify.wiki/FunkinCrew/Funkin/api/play/notes.md): Note rendering and strumline management system
- [Stage](https://mintlify.wiki/FunkinCrew/Funkin/api/play/stage.md): Stage system for backgrounds, props, and character positioning
- [PlayState](https://mintlify.wiki/FunkinCrew/Funkin/api/playstate.md): Main gameplay state where rhythm gaming happens
- [Preferences](https://mintlify.wiki/FunkinCrew/Funkin/api/preferences.md): User-configurable game settings and preferences
- [Compiling Friday Night Funkin'](https://mintlify.wiki/FunkinCrew/Funkin/development/compiling.md): Complete guide to compiling Friday Night Funkin' from source for all platforms
- [Mac Compilation Guide](https://mintlify.wiki/FunkinCrew/Funkin/development/compiling-mac.md): Additional considerations when compiling Friday Night Funkin' for macOS
- [Mobile Compilation Guide](https://mintlify.wiki/FunkinCrew/Funkin/development/compiling-mobile.md): Complete guide to compiling Friday Night Funkin' for Android and iOS
- [Contributing to Friday Night Funkin'](https://mintlify.wiki/FunkinCrew/Funkin/development/contributing.md): Guidelines for contributing code, opening issues, and submitting pull requests
- [Code Style Guide](https://mintlify.wiki/FunkinCrew/Funkin/development/style-guide.md): Coding conventions and best practices for the Funkin' repository
- [Troubleshooting Compilation Issues](https://mintlify.wiki/FunkinCrew/Funkin/development/troubleshooting.md): Solutions to common compilation and runtime problems
- [Introduction to Friday Night Funkin'](https://mintlify.wiki/FunkinCrew/Funkin/introduction.md): Learn about Friday Night Funkin', the open-source rhythm game built with HaxeFlixel, and discover what these documentation pages can help you accomplish.
- [Creating Mods](https://mintlify.wiki/FunkinCrew/Funkin/modding/creating-mods.md): Step-by-step guide to creating your first Friday Night Funkin' mod
- [Installing Mods](https://mintlify.wiki/FunkinCrew/Funkin/modding/installing-mods.md): How to install Friday Night Funkin' mods on different platforms
- [Modding Overview](https://mintlify.wiki/FunkinCrew/Funkin/modding/overview.md): Learn about Friday Night Funkin's modding system powered by Polymod
- [Polymod Deep Dive](https://mintlify.wiki/FunkinCrew/Funkin/modding/polymod.md): Advanced guide to Polymod's asset replacement, merging, and modding system
- [Scripting with HScript](https://mintlify.wiki/FunkinCrew/Funkin/modding/scripting.md): Write custom gameplay code using HScript in Friday Night Funkin' mods
- [Playing Friday Night Funkin'](https://mintlify.wiki/FunkinCrew/Funkin/playing.md): Master the controls, understand gameplay mechanics, and learn about the different game modes in Friday Night Funkin'.
- [Quick Start Guide](https://mintlify.wiki/FunkinCrew/Funkin/quickstart.md): Get Friday Night Funkin' compiled and running on your machine with this step-by-step guide for Windows, macOS, and Linux.
- [Character System](https://mintlify.wiki/FunkinCrew/Funkin/systems/characters.md): Character architecture, animations, character data format, and rendering
- [Charting System](https://mintlify.wiki/FunkinCrew/Funkin/systems/charting.md): Chart format, note types, events, sections, and chart data structure
- [Gameplay System](https://mintlify.wiki/FunkinCrew/Funkin/systems/gameplay.md): Core gameplay loop, timing system, scoring, and difficulty mechanics
- [Song System](https://mintlify.wiki/FunkinCrew/Funkin/systems/songs.md): Song structure, metadata, audio files, BPM, and time changes
- [Stage System](https://mintlify.wiki/FunkinCrew/Funkin/systems/stages.md): Stage architecture, props, camera system, and stage data format
- [Animation Editor](https://mintlify.wiki/FunkinCrew/Funkin/tools/animation-editor.md): Edit character animations, adjust frame offsets, and preview sprite atlases
- [Chart Editor](https://mintlify.wiki/FunkinCrew/Funkin/tools/chart-editor.md): Complete guide to using the Chart Editor to create and edit song charts in Friday Night Funkin'
- [Debug Hotkeys](https://mintlify.wiki/FunkinCrew/Funkin/tools/debug-hotkeys.md): Complete reference of all debug hotkeys and development features in Friday Night Funkin'
- [Stage Editor](https://mintlify.wiki/FunkinCrew/Funkin/tools/stage-editor.md): Guide to using the Stage Editor for creating and arranging stage props and camera zones