gophengine

README

🎤 GophEngine

English 🇺🇸 | Slovenčina 🇸🇰

Status: work-in-progress

GophEngine is a Go implementation of Friday Night Funkin' v0.2.7.1 with improvements and an alternative to vanilla FNF.

[!NOTE] This is a mod. This is not the vanilla game and should be treated as a modification.

Why?

I created GophEngine for several reasons:

• To develop an easy-to-use Go modding MDK for Friday Night Funkin', similar to MinecraftForge but for FNF.
• To fix issues in the vanilla FNF engine and add new features and improvements.
• To foster a positive and non-toxic community around the game without the toxic community.
• To remove violent NSFL (Not Safe For Life) content introduced in FNF v0.3.2, and create a cleaner version of the game.
• To rewrite the game in Go, my favorite programming language.

Why Go?

Go is my favorite programming language, and I prefer it over learning Haxe.

Features

• Enhanced privacy with no Newgrounds integration
• Entirely written in Go with no Haxe
• Family-friendly and welcoming to Boyfriend fans (no NSFW/L content)
• Small tweaks and optimizations for a smoother and more enjoyable experience
• Lower RAM consumption and overall smaller footprint
• A proper options menu for better customization
• Robust Go modding MDK for easy modification
• Faster compile times

Hardware Requirements

Component	Minimum	Recommended
Processor	Intel Core i3 / AMD Ryzen 3	Intel Core i5 / AMD Ryzen 5
Memory	4 GB	8 GB
Graphics Card	Intel HD Graphics 4000 / NVIDIA GeForce GTX 600 Series / AMD Radeon HD 7000 Series	Intel HD Graphics 5000 / NVIDIA GeForce GTX 750 Ti / AMD Radeon RX 560
DirectX / OpenGL	DirectX 11 / OpenGL 3.0	DirectX 12 / OpenGL 4.5
Storage	256 MB	512 MB
Operating System	Windows 7 / macOS 10.12 / Linux 2.6.32	Windows 11 / macOS 10.15 / Linux 5.x.x

Building & installing (from source)

Build instructions for GophEngine are available in BUILDING.md.

Naming

The name "GophEngine" combines "Goph" (representing Gopher, the Go programming language mascot) and "Engine" (representing the FNF engine). It felt more natural and fitting for this project than "funkin-go."

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details on how to get started.

License

Licensed under the Apache License 2.0 (see LICENSE)

Credits

• The Funkin' Crew - Original game
• Hajime Hoshi - Ebitengine
• The Ebitengine logo by Hajime Hoshi is licensed under the Creative Commons Attribution-NoDerivatives 4.0.
• The Go Gopher mascot was created by Renee French and is licensed under the Creative Commons 4.0 Attribution License.

💲 Donate

If you enjoy playing GophEngine and would like to support its development, consider making a donation. Every bit of support is greatly appreciated! (pls I need money to buy Kofola)

You can donate through the following platforms:

• Bitcoin (BTC): bc1qtykrhm2ar9jreha5rnqve72lutw02jzpu6lcgs
• Duino-Coin (DUCO): SladkyCitron
• Magi (XMG): 9K8GrfCGEvTK7qjDMVtkGE18UfRyUkv5QT or SladkyCitron

Thank you for your support! 😊

Documentation

Index

• Constants
• func LoadKeymapFromConfig(cfg *config.Config) (input.Keymap, error)
• type BPMChangeEvent
• type Conductor
  • func NewConductor(bpm int) *Conductor
  • func (c *Conductor) ChangeBPM(newBpm int)
  • func (c *Conductor) MapBPMChanges(song *Song)
• type Flasher
  • func NewFlasher(width, height int, dur float32) *Flasher
  • func (f *Flasher) Draw(img *ebiten.Image)
  • func (f *Flasher) Flash()
  • func (f *Flasher) Update(dt float64)
• type Flicker
  • func NewFlicker(spr *Sprite, dur time.Duration, interval time.Duration) *Flicker
  • func (f *Flicker) Flicker()
  • func (f *Flicker) Update() error
• type IntroText
  • func NewIntroText(fsys fs.FS) (*IntroText, error)
  • func (it *IntroText) AddText(text string)
  • func (it *IntroText) CreateText(text ...string)
  • func (it *IntroText) DeleteText()
  • func (it *IntroText) Draw(img *ebiten.Image)
  • func (it *IntroText) Update(dt float64) error
• type MusicBeat
  • func NewMusicBeat(c *Conductor) *MusicBeat
  • func (mb *MusicBeat) BeatHit()
  • func (mb *MusicBeat) StepHit()
  • func (mb *MusicBeat) Update()
  • func (mb *MusicBeat) UpdateBeat()
  • func (mb *MusicBeat) UpdateCurStep()
• type Scene
• type SceneController
  • func NewStateController(state Scene) *SceneController
  • func (sc *SceneController) Close() error
  • func (sc *SceneController) Draw(screen *ebiten.Image)
  • func (sc *SceneController) SwitchScene(newScene Scene) error
  • func (sc *SceneController) Update(dt float64) error
• type Section
• type Song
  • func LoadSongFromJSON(rawJson []byte) (*Song, error)
• type Sprite
  • func NewSprite(x, y int) *Sprite
  • func (s *Sprite) Draw(img *ebiten.Image)
  • func (s *Sprite) DrawImageOptions() *ebiten.DrawImageOptions
  • func (s *Sprite) DrawWithOptions(img *ebiten.Image, opts *ebiten.DrawImageOptions)

Constants

const (
	ActionUp input.Action = iota
	ActionDown
	ActionLeft
	ActionRight
	ActionAccept
	ActionBack
	ActionPause
	ActionReset
	ActionFullscreen
)

Functions

func LoadKeymapFromConfig

func LoadKeymapFromConfig(cfg *config.Config) (input.Keymap, error)

Types

type BPMChangeEvent

type BPMChangeEvent struct {
	StepTime int
	SongTime float64
	Bpm      int
}

type Conductor

type Conductor struct {
	Bpm            int
	Crochet        float64
	StepCrochet    float64
	SongPosition   float64
	LastSongPos    float64
	Offset         float64
	SafeFrames     int
	SafeZoneOffset float64
	BPMChangeMap   []BPMChangeEvent
}

func NewConductor

func NewConductor(bpm int) *Conductor

func (*Conductor) ChangeBPM

func (c *Conductor) ChangeBPM(newBpm int)

func (*Conductor) MapBPMChanges

func (c *Conductor) MapBPMChanges(song *Song)

type Flasher

type Flasher struct {
	// contains filtered or unexported fields
}

func NewFlasher

func NewFlasher(width, height int, dur float32) *Flasher

func (*Flasher) Draw

func (f *Flasher) Draw(img *ebiten.Image)

func (*Flasher) Flash

func (f *Flasher) Flash()

func (*Flasher) Update

func (f *Flasher) Update(dt float64)

type Flicker

type Flicker struct {
	Sprite *Sprite

	OnCompleteCallback func() error
	// contains filtered or unexported fields
}

func NewFlicker

func NewFlicker(spr *Sprite, dur time.Duration, interval time.Duration) *Flicker

func (*Flicker) Flicker

func (f *Flicker) Flicker()

func (*Flicker) Update

func (f *Flicker) Update() error

type IntroText

type IntroText struct {
	// contains filtered or unexported fields
}

func NewIntroText

func NewIntroText(fsys fs.FS) (*IntroText, error)

func (*IntroText) AddText

func (it *IntroText) AddText(text string)

func (*IntroText) CreateText

func (it *IntroText) CreateText(text ...string)

func (*IntroText) DeleteText

func (it *IntroText) DeleteText()

func (*IntroText) Draw

func (it *IntroText) Draw(img *ebiten.Image)

func (*IntroText) Update

func (it *IntroText) Update(dt float64) error

type MusicBeat

type MusicBeat struct {
	LastBeat float64
	LastStep float64

	CurBeat int
	CurStep int

	StepHitFunc func(int)
	BeatHitFunc func(int)
	// contains filtered or unexported fields
}

MusicBeat is basically MusicBeatState in vanilla FNF.

func NewMusicBeat

func NewMusicBeat(c *Conductor) *MusicBeat

func (*MusicBeat) BeatHit

func (mb *MusicBeat) BeatHit()

func (*MusicBeat) StepHit

func (mb *MusicBeat) StepHit()

func (*MusicBeat) Update

func (mb *MusicBeat) Update()

func (*MusicBeat) UpdateBeat

func (mb *MusicBeat) UpdateBeat()

func (*MusicBeat) UpdateCurStep

func (mb *MusicBeat) UpdateCurStep()

type Scene

type Scene interface {
	io.Closer

	// Init initializes the scene. It's called once before the scene is displayed.
	Init() error

	// Update updates the scene by one tick; dt is the time since the last update (aka delta time).
	// dt is only used internally by gween (the tweening library), otherwise don't use this. It could be omitted if not necessary for your case.
	Update(dt float64) error

	// Draw renders the scene onto the screen for the current frame.
	Draw(screen *ebiten.Image)
}

Scene represents a game scene.

type SceneController

type SceneController struct {
	// contains filtered or unexported fields
}

func NewStateController

func NewStateController(state Scene) *SceneController

func (*SceneController) Close

func (sc *SceneController) Close() error

func (*SceneController) Draw

func (sc *SceneController) Draw(screen *ebiten.Image)

func (*SceneController) SwitchScene

func (sc *SceneController) SwitchScene(newScene Scene) error

func (*SceneController) Update

func (sc *SceneController) Update(dt float64) error

type Section

type Section struct {
	SectionNotes   [][]interface{} `json:"sectionNotes"`
	LengthInSteps  int             `json:"lengthInSteps"`
	TypeOfSection  int             `json:"typeOfSection"`
	MustHitSection bool            `json:"mustHitSection"`
	Bpm            int             `json:"bpm"`
	ChangeBPM      bool            `json:"changeBPM"`
	AltAnim        bool            `json:"altAnim"`
}

type Song

type Song struct {
	Song        string    `json:"song"`
	Notes       []Section `json:"notes"`
	Bpm         int       `json:"bpm"`
	NeedsVoices bool      `json:"needsVoices"`
	Speed       float64   `json:"speed"`
	Player1     string    `json:"player1"`
	Player2     string    `json:"player2"`
	ValidScore  bool      `json:"validScore"`
}

func LoadSongFromJSON

func LoadSongFromJSON(rawJson []byte) (*Song, error)

type Sprite

type Sprite struct {
	Position       image.Point
	Img            *ebiten.Image
	Visible        bool
	AnimController *anim.AnimController
}

func NewSprite

func NewSprite(x, y int) *Sprite

func (*Sprite) Draw

func (s *Sprite) Draw(img *ebiten.Image)

func (*Sprite) DrawImageOptions

func (s *Sprite) DrawImageOptions() *ebiten.DrawImageOptions

func (*Sprite) DrawWithOptions

func (s *Sprite) DrawWithOptions(img *ebiten.Image, opts *ebiten.DrawImageOptions)