README
¶
🎤 GophEngine
Status: work-in-progress
GophEngine is a Go implementation of Friday Night Funkin' with improvments.
NOTE: This is a mod. This is not the vanilla game and should be treated as a modification.
Why?
I wanted to make a easy to use Go (my fav programming language) modding API for Friday Night Funkin' (my fav game). Something like MinecraftForge but for FNF.
I also wanted to fix everything what's wrong with the vanilla FNF engine and add some more features and improvments.
Why Go?
Go is my favorite programming language and I don't wanna learn Haxe.
Naming
"Goph" means Go Gopher (Go programming language mascot) and "Engine" means FNF engine. I wanted to call this funkin-go, but "I made a mod with GophEngine" just sounds more natural than "I made a mod with funkin-go".
Building & installing (from source)
Build instructions for GophEngine are available in BUILDING.md.
Notable tools and libraries
- Ebitengine - graphics and input
- Beep - audio
- ganim8 - animations
- go-winres - embedding .ico files
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
character/boyfriend
Package boyfriend implements Boyfriend as defined here: https://github.com/FunkinCrew/Funkin/blob/v0.2.7.1/source/Boyfriend.hx
|
Package boyfriend implements Boyfriend as defined here: https://github.com/FunkinCrew/Funkin/blob/v0.2.7.1/source/Boyfriend.hx |
|
config
Package config implements a simple key-value store used to securely store game save data and high scores in a non-human readable binary format.
|
Package config implements a simple key-value store used to securely store game save data and high scores in a non-human readable binary format. |