Skip to content

TheoDevelops/FunkinModchart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FunkinModchart

An Modcharting backend library for Friday Night Funkin' made by modders, to modders.

FunkinModchart is a tool designed to bring NotITG visuals and capabilities to Friday Night Funkin, adding modifiers to change the arrow trajectory, colors, transparency and the rotation angle through 3D Axes, event system to change the modifier's percent easing or setting those to create endless amazing visual effects and even more!.

This framework also provides extra features that can help you to make even more crazy visuals, as arrow paths, 3D view camera, AFTs, etc. (If you have already modeled NotITG or StepMania, you know what I am talking about)

Importing the library

This library currently has support for multiple engines such as Codename Engine and Psych Engine, click here for more information, and only takes a couple of lines of code to import it:

Go to your project and open Project.xml

At the bottom of where the haxelib section is, paste this code.

<haxedef name="FM_ENGINE" value="YOUR_ENGINE"/>
<haxedef name="FM_ENGINE_VERSION" value="ENGINE_VERSION"/>

<haxelib name="funkin-modchart" />
<haxeflag name="--macro" value="modchart.core.macros.Macro.includeFiles()"/>

Fill in the definitions with your engine name and version using the format mentioned.

And if you did everything good, it should compile and work normal !

Using the library

This is the easiest thing, you only have to do a couple of steps for add the modchart instance to a song.

Import modchart.Manager

And then make an instance of it, and add it to the state.

var funkin_modchart_instance:Manager = new Manager();
// On your create function.
add(funkin_modchart_instance);

This can be done via haxe scripts or source code, and will soon be possible in PsychLua for PSYCH as well.

Make sure that at the time you create the instance, the notes and strums were already generated. This now all the stuff should be working, do your stuff now.

Making a Modchart

First, you should know all the modcharting functions, check they here. To make a modchart you don't necessarily have to follow instructions, it's a matter of experimenting with the modifiers and all the functions that FunkinModchart offers, although previous experience with The Mirin Template and NotITG would help you design a good modchart more easily.

Making your own Adapter

to do heheheh, if u know coding just check psych and codename adapters and u'll figure out (also check Adapter.hx and AdapterMacro.hx for more information) also OBVIOUSLY has to be an flixel-based fnf engine

Credits

TheoDev: Owner, Lead coder.

Ne_Eo (aka. Neo): Coder, bugfixes & Optimizer.

Edwhak: Maintainer.

OpenITG: Some math taken for modifiers.

4mbr0s3: Some code taken from Schmovin', his own Modcharting Lib. (really impressive)

Special Thanks

lunarcleint: Support, such a nice guy!

Tsaku: Support, bug finder. (thanks !!!)

About

An modcharting plugin for Friday Night Funkin'

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages