Skip to content

Latest commit

 

History

History
144 lines (127 loc) · 16.9 KB

README.md

File metadata and controls

144 lines (127 loc) · 16.9 KB
Raw

funkin-resources

Various community curated resources for the game Friday Night Funkin', by The Funkin' Crew Inc.

Contributor Covenant

This will hopefully be a nice, catchall place for nearly damn everything Friday Night Funkin' related for fans, modders, freaks, and addicts.

I intend for this to be a bit community run type beat. I'll slowly find things and add it to this list, but I am not the biggest Friday Night Funkin' maniac, and not by a damn longshot! The inspiration behind this list thingie is those Github AWESOME lists that have a billion damn resources. I'm no FNF maniac, but I think it would be nice if everything was in one place!!! I will host this on the FunkinCrew github page, and upload it to the FNF website, but otherwise, I will say if there's dedicated people around, I'm willing to let some trusted individuals who are much more in touch than me to keep things around here nice and pleasant and a nice resource that doesn't get too outdated! -signed ninjamuffin99

some of these resources i stole from /funkg/... lol i hope u rascals over there dont mind!!!!

Further reading:

  • The Awesome Manifesto (bit of inspiration behind this)
  • Awesome lists contributing guidelines (again, it's main inspiration to this! So these are general loose guidelines! Not hard rules tho, we will get there when we get there!!!
  • The Funkin' Blog - self plug a bit, also dunno where to put this right now, the FNF weekly devblog. Maybe we add a section around here core dev team? is that too self indulgent? lol?

Unsure what to contribute? Check out the good first issue tagged Github issues!

Contents

Animation

Spritesheet Generation

  • FNF Spritesheet and XML Maker - Combines individual frames together into spritesheets for FNF, and helps you manage animations.
  • Free Texture Packer - Combines individual frames together into spritesheets. Has options to remove duplicate frames and rearrange frames to minimize texture size. Make sure to select Starling as the output format.
  • oxipng - Simple program for general image optimization but also works nicely with FNF Sprite Sheets
  • compresspng - Website for general image optimization, compresses a little more than oxipng

Composing

Chromatic Scale Guides

Programming

Engines and Forks

  • Psych Engine - A fork of base game which includes new quality-of-life changes, performance improvements, and Lua-based mod tools. Popular and well-documented.
    • Psych Engine Docs - Psych Engine modding documentation (sorta outdated).
    • Alternatively, a more up-to-date Psych wiki exists, made by CaptainBaldi and contributors, which you can view here.
    • Funkin Cocoa - A rewrite of base game (Psych 0.4). Aims to be as customizable as possible. Supports advanced HScript scripting using SScript.
  • Kade Engine - A legacy engine which includes new features and quality of life fixes, targeted at pro rhythm game players. Officially deprecated.
    • BovoVevo's Kade Engine - A fork of Kade Engine that fixes all the bugs and includes new content.
    • Edak Engine - A fork of Kade Engine, with HScript support, softcoding, cleaner file system, configurable weeks and more. It also comes with B-Side Remixes Legacy's assets.
  • Forever Engine - An archived rewrite of the game, originally written by Yoshubs. Includes performance reworks, HScript support, and more.
    • Forever Engine Feather - A fork of Forever Engine, that includes all of its features, a scripting system based on HScript, called SScript, reorganized codebase, an events system based off of Hypno's Lullaby v2 and fully softcoded weeks and characters.
  • Codename Engine - A fork of base game that provides full HScript support for advanced softcoding, along with sorted and half rewritten source for optimisation and ease of use.
  • Andromeda Engine Legacy - Fork of Funkin' with customization and gameplay in mind.
    • Andromeda Engine Docs - Andromeda Engine (LEGACY) Modchart API documentation.
    • Andromeda 2.0 NOTE: Andromeda 2.0 is in HEAVY development and is in a very early alpha stage.
  • FPS Plus - A fork of Funkin', as the name suggests, higher framerate, better input system, rebindable keys and more. B-Side Redux was made on this engine.
  • Mic'd Up Engine - A deprecated engine which features revamped menus, additional difficulties for base game songs, endless mode, and modifiers.
  • Altronix Engine - An engine that provides the support for creating localizations into different languages and HScript modding support with Polymod HScript classes and small script files. Also engine has integration with GameJolt with achievements.
  • FNF-NewgroundsPort - Rebuild of Funkin' 0.2.8 via reverse engineering.
  • CrowEngine - modified version of base Funkin' that has been rebuilt to include comprehensive documentation for modding and to introduce new features.

Rewrites and Ports

  • FNF LÖVE - A Lua recreation of FNF within the LÖVE2D engine. Can compile for Nintendo Switch Homebrew.
  • FNF-Benjine - Funkin' but in Godot, made by BennyK and was used for Funkin' VR.
  • PydayNightFunkin - A recreation of FNF in Python, allowing for quick changeability! Tries to be painlessly readable and is somewhat documented.
  • Funkin' Android - A fork of the game with controls and optimizations allowing it to be played on Android devices.
  • FNF Pocket Engine - An engine optimized for and Android phone, ironically based on the "FNF MOBILE" rip-offs in the Play Store
  • FunkiniOS - A port of FNF to iOS devices, requires sideloading (thank god for the EU regulations)
  • PSXFunkin - A Playstation 1 de-make in C/C++

Visual Studio Code

  • Visual Studio Code is highly recommended, as it is the only integrated development environment (IDE) with proper support for Haxe (via extensions).
    • Enable VSCode Debug Tools - A Twitter thread made by EliteMasterEric showing useful tips and tricks for Visual Studio Code.
  • Funkin' Script AutoComplete - A Visual Studio Code extension for Psych Engine you can use that will auto complete functions, variables etc. in your Lua script.
  • Source Code Guide | OVERHAUL - That one famous GameBanana compile guide. Also includes tutorials, like adding songs, custom characters, etc. (originally targeted towards Funkin' 0.2.7.1)

Haxe/HaxeFlixel Resources

Charting

Modding

Modding Tutorials