notweuz / fnf-osengine

Just psych engine, but bit different. Feel free to suggest ideas in discord

Friday Night Funkin' - OS Engine - Modded Psych Engine

Installation:

You must have the most up-to-date version of Haxe, seriously, stop using 4.1.5, it misses some stuff.

Follow a Friday Night Funkin' source code compilation tutorial, after this you will need to install LuaJIT.

To install LuaJIT do this: haxelib git linc_luajit https://github.com/nebulazorua/linc_luajit on a Command prompt/PowerShell

...Or if you don't want your mod to be able to run .lua scripts, delete the "LUA_ALLOWED" line on Project.xml

If you get an error about StatePointer when using Lua, run haxelib remove linc_luajit into Command Prompt/PowerShell, then re-install linc_luajit.

If you want video support on your mod, simply do haxelib install hxCodec on a Command prompt/PowerShell

OS Engine Credits:

• weuz_ - Coding
• nelifs - Coding and Design
• Cooljer - Arts

OS Engine Special Thanks

• jonnycat - Fixing bugs in Engine <3.
• Kade Engine - Circle Note Skin

Psych Engine Credits:

• Shadow Mario - Programmer
• RiverOaken - Artist
• Yoshubs - Assistant Programmer

Psych Engine Special Thanks

• bbpanzu - Ex-Programmer
• shubs - New Input System
• SqirraRNG - Crash Handler and Base code for Chart Editor's Waveform
• KadeDev - Fixed some cool stuff on Chart Editor and other PRs
• iFlicky - Composer of Psync and Tea Time, also made the Dialogue Sounds
• PolybiusProxy - .MP4 Video Loader Library (hxCodec)
• Keoiki - Note Splash Animations
• Smokey - Sprite Atlas Support
• Nebula the Zorua - LUA JIT Fork and some Lua reworks & VCR Shader code

---

Features

Psych Engine Features

OS Engine is a fork of Psych Engine, so you can use almost every feature from Psych Engine in OS Engine!

OS Engine Features

Psych Engine mods compability

Yes, almost every mod for Psych Engine runs on OS Engine.

Note Skins

OS Engine adds a note skins system! There's only Default and Circle skins by default.

Showcase Mode

This feature hides HUD and enables botplay. So you can showcase any mod without any problems.

Hide Score Text

This feature hides score text under health bar. Idk why you need to use it.

Perfect!! Judgement

Adds Perfect!! Judgement. It's better than sick. Btw you can disable it in settings if you want.

Lane Underlay

You can set lane underlay transparency under arrows by using that functions.

Custom Settings in Chart Editor.

There's multiple new functions in chart editor. Like player/opponent trail, camera move and etc.

Literally Useless Exit Game State

Now you can press ESC at title state. And game will ask you do you want to close game or no

Bit Changed Main Menu State

Winning icons

Instead of 2 icons, there'll be three icons (losing, normal, winning). And yes, you can use double icons (without winning).

thanks Cooljer for remaking original fnf icons

Shaders

Returned shaders from old psych engine versions. Now you can make your bambi mods.

Custom Title State

Bit changed Title State. Now it looks way more better.

Striped Health Bar

Cassette Girl vibes?

fnf-osengine's Issues

shaders not working on sprites

Describe your bug here.

I tried to add the distortion effect shader to the bg but it didn't work
I tried other shaders but they also didn't work

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

No

More than one opponent

What feature do you want to get added on the base engine?

More than one opponent. It would have its own section in the debug menu and would look like this.

To test your sight, and reliability, please select the option of what should NOT be requested.

6K+ support.

Ability to add Camera Movement as a toggle.

What feature do you want to get added on the base engine?

Pretty simple. It's already available on the chart editor but it'd be cool to have it as a universal toggle.

To test your sight, and reliability, please select the option of what should NOT be requested.

Stage Editor, 6K+ support, and winning icons.

A button for the mouse to go back in mods.

What feature do you want to get added on the base engine?

A button for the mouse to go back in mods
Its frustrating that i can manage the mods easy with the mouse and to go back to menu i need to press backspace.

To test your sight, and reliability, please select the option of what should NOT be requested.

Stage Editor, 6K+ support or Winning Icons.

how can I make shaders appear on a specific beat?

Describe your problem here.

tried this, but they never show up

if you have an answer that would be greatly appreciated

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows x64

Did you edit anything in this build? If so, mention or summarize your changes.

no

Voice Waveform Doesn't work

Describe your bug here.

Pretty self-explanatory

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

no

more lua function bullshit

What feature do you want to get added on the base engine?

More LUA functions and variables. For example:
makeLuaCharacter(tag, character json name, x, y, flipX)
Creates a character in the current instance of PlayState.
addLuaCharacter(tag)
removeLuaCharacter(tag)
Adds and removes the Lua character, respectively.
setCharacterType(tag, charType)
Lua equivalent of PlayState.instance.chartype.push(tag).

CharType is between boyfriends, gfs and dads.

Just add stuff for making new characters without source code. It's a lot easier than making a replica of character.hx in lua.

To test your sight, and reliability, please select the option of what should NOT be requested.

6K+ support.

alphabet text with lua

What feature do you want to get added on the base engine?

a function in the lua API that could act like makeLuaText() but with the alphabet font in the freeplay menu and stuff

To test your sight, and reliability, please select the option of what should NOT be requested.

6K+ support.

How tho?

What is your question?

How did you make the checkerboard background for the title screen?

How do you download artifacts?

What is your question?

I tried going to the actions tab to download the new artifact, since I saw a new commit, and tried clicking on the text at the bottom that said 'buildWindows' but it didn't work. IDK what I am doing wrong because I know that's how you used to download artifacts, but it doesn't work anymore. Help, please?

week title being weird + afterimage broken

Describe your bug here.

and after you change a character with character trails on, you get this

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

no

error while compiling last version

Describe your bug here.

when compiling the last version of OS engine i get this error:
source/FunkinLua.hx:346: lines 346-350 : Int should be Bool
source/FunkinLua.hx:346: lines 346-350 : ... For function argument 'f'
how to fix it??

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

no, i just compile first the engine before do my changes

winning icons don't work

Describe your bug here.

I place an icon image with a winning icon in the files and this happens (the whitty icon is the one that's broken):

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

no

What's the difference?

What is your question?

What do you have that psych engine doesn't?

I don't want to mess this up.

Describe your problem here.

Do you think it would be okay to throw the GameExitState and the shaders in my custom Psych Engine?

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows x64

Did you edit anything in this build? If so, mention or summarize your changes.

A lot.

Error: Could not find haxelib "discord_rpc", does it need to be installed?

Describe your problem here.

I have discord_rpc installed, but it can't find it.

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows x64

Did you edit anything in this build? If so, mention or summarize your changes.

Yes. I edited PlayState.hx and MainMenuState.hx.

Using Hide Middlescroll Opponent Notes disables the opponent notes when not using middlescroll.

Describe your bug here.

Nothing else needs to be said, I guess.

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

No, this is the base OS Engine.

Game likes to freeze

Describe your bug here.

here's the problem:
freezing

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

no

Mods folder should have an "overwrite" folder to make things look pretty.

What feature do you want to get added on the base engine?

Since this is a Psych Engine fork, how about adding this feature?

Basically, Psych Engine treats overwriting by placing the file you want to overwrite straight to the mods folder itself, according to the original file's path in assets.

For example: If you want to replace a song for a week, instead of directly overwriting the base game equivalent, you can put the song in mods/songs/song-name folder instead and the jsons in mods/data/song-name instead.

This suggestion basically places an overwrite folder which allows the mods folder to be clean of unnecessary folders.

To test your sight, and reliability, please select the option of what should NOT be requested.

Stage Editor, 6K+ support, and winning icons.

Blammed Lights

What is your question?

Why'd you remove the Blammed Lights event?

A Results Screen at the end of the song / week

What feature do you want to get added on the base engine?

The title already says it, but a Results Screen at the end of each song / week telling how many notes you've hitten, the amounts of ratings you got, etc... like Kade Engine has.

To test your sight, and reliability, please select the option of what should NOT be requested.

Stage Editor, 6K+ support.

Hardcoded Noteskins crash the game on pixel stage.

Describe your bug here.

I added some alternative noteskins in a build and having them enabled when going into any week 6 song/song that uses pixel notes, the game crashes with the following crash report. The best way to fix it is to probably have hardcoded custom noteskins override the pixel notes if a pixel note alternative of the noteskin does not exist.
OSEngine_2022-06-30_19'56'17.txt

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

Edited some stuff for custom noteskin support and custom options lol

good engine

What is your question?

good engine

Game crashes if character has noteskin

Describe your bug here.

The game crashes if a character has a special noteskin.

Command Prompt/Terminal logs (if existing)

Image is in the replies.

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

no

can't press 7

Describe your bug here.

the button I have to go into the chart editor is 7 like it normally is for all other fnf stuff, but for some reason, 7 won't take me into the chart editor, the only way I can go into the chart editor is if I go into the freeplay menu and press shift+enter on the song I want to chart

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

no

Camera is broken

Describe your bug here.

Look at the first 20 seconds and then look at what happens when I restart:
bug video
the first 20 seconds show the broken camera

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

not that I know of

how to do this?

What is your question?

i want to figure out how to do shaders to the camera. can someone show me how? i dont understand.

Dialogue Code in previous updates are specifically for non-Windows computers

What feature do you want to get added on the base engine?

So from what I've gathered, if you're planning to make a Mac version of OS Engine, or just allow OS Engine to run on anything that isn't Windows, THEN you would make Function_Stop and Function_Continue = 'Function_Stop' and 'Function_Continue'. Otherwise, Function_Stop = 0 and Function_Continue = 1. I actually wrote some code to get around this.

#if windows
public static var Function_Stop:Dynamic = 1;
public static var Function_Continue:Dynamic = 0;
#else
public static var Function_Stop:Dynamic = 'Function_Stop';
public static var Function_Continue:Dynamic = 'Function_Stop';
#end

#if windows
set('Function_Stop', Function_Stop);
set('Function_Continue', Function_Continue);
#else
set('Function_Stop', 'Function_Stop');
set('Function_Continue', 'Function_Continue');
#end

Also, if there are any more systems that require the 0-1 function and not the string function, you can write
#if (windows or android). I don't know if android runs the 0-1 function, I just used it as an example.

To test your sight, and reliability, please select the option of what should NOT be requested.

Stage Editor, 6K+ support.

Shaders

Describe your problem here.

How do i add my own shaders, i already have the frag file on the shaders folder but i need help enabling it

Are you modding a build from source or with Lua?

Lua

What is your build target?

Neko, HashLink, or other build system

Did you edit anything in this build? If so, mention or summarize your changes.

No

Week 7 cutscenes

What needs to be documented?

They play, I know this is only a problem with OS because it doesn't happen on psych
proof video

how do i even add wavy bg

What is your question?

so i realized os had shaders and so how do i make a wavy bg

stage not showing

Describe your bug here.

When I made the stage .json and .lua I'm pretty sure I did everything correctly adding them but then when I try to load the stage it does not work other than the offsets for Bf & Gf is there anyway I can resolve this?

and yes It completely just a black background with the opponent no where in site.

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

I used the stage editor & made the .json & .lua file but the stage is not working

Help

Describe your problem here.

On the latest version (1.5.0) this happens when I go to freeplay and when I put my mods but when I don't it's normal also it only happens on some mods not all

flixel/FlxSprite.hx (line 1197)
flixel/FlxSprite.hx (line 1326)
flixel/FlxSprite.hx (line 403)
HealthIcon.hx (line 53)
HealthIcon.hx (line 20)
FreeplayState.hx (line 133)
flixel/FlxGame.hx (line 637)
flixel/FlxGame.hx (line 724)
flixel/FlxGame.hx (line 677)
flixel/FlxGame.hx (line 545)
openfl/events/EventDispatcher.hx (line 402)
openfl/display/DisplayObject.hx (line 1399)

Uncaught Error: Null Object Reference
Please report this error to the GitHub page: https://github.com/notweuz/FNF-OSEngine

Crash Handler written by: sqirra-rng

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows x64

Did you edit anything in this build? If so, mention or summarize your changes.

No response

I got an error when compiling that says "source/Discord.hx:8: characters 8-18 : Type not found : llua.State "

Describe your problem here.

It says the same thing but at different lines and is also present in FunkinLua.hx.

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows x64

Did you edit anything in this build? If so, mention or summarize your changes.

I only added 2 new states and changed a few things in some pre-existing states not even related to the errors.

Game freezes when entering a song

Describe your problem here.

On the newest version of Os (1.5.1) some songs freeze my game, the songs that freeze my game have shaders so idk if it's that, because when I remove the script that has the shaders it still does it. The songs work on older versions of Os.

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows x64

Did you edit anything in this build? If so, mention or summarize your changes.

No response

Hardcoded noteskins crash the game.

Describe your bug here.

Game crashes when I try to use custom noteskins. Classic and Circle work just fine, but the 5 new ones I'm trying to add give the crash report (attached).
OSEngine_2022-06-28_20'52'28.txt

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

I added them into VisualsUISubstate.hx, Note.hx, and StrumNote.hx.

Compilation error

Describe your bug here.

when I wanted to compile the code, an error comes out

Command Prompt/Terminal logs (if existing)

lime test windows lol

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

...

can I work with you?

What is your question?

I can be porter and fix shader error code here my discord Jonnycat#8275

Clickable buttons

What feature do you want to get added on the base engine?

A new variable in mainView.xml that lets you use the mouse to select the buttons

To test your sight, and reliability, please select the option of what should NOT be requested.

6K+ support.

Crashing near the end of a song.

Describe your bug here.

The engine likes to crash near the end of a song for some reason. I'm using the most recent commit of FunkinLua.hx which had an issue causing some crashes, but it seems to still be occurring. Pretty certain its a Psych Engine issue, but its happening in OS Engine so I figured I'd make it known. I am able to reproduce the issue on Ballistic, so if anything there is useful, take it as you will. I'm 90% sure its a lua/animated sprite issue.

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

Edited Playstate.hx for rating bar and some assets (shown above). Removed mentions of achivements and credits. (It is a personal, unshared build but the crashing should not be caused by these factors.)

Int should be flixel.FlxObject ... For function argument 'Object'

Describe your bug here.

Not sure why but suddenly i've started getting a compiling bug after changing stuff in MainMenuState.hx. Any help to solve this would be appreciated!

Command Prompt/Terminal logs (if existing)

source/MainMenuState.hx:282: characters 50-60 : Int should be flixel.FlxObject
source/MainMenuState.hx:282: characters 50-60 : ... For function argument 'Object'

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

I changed TitleState.hx and MainMenuState.hx, thats it.

If you have lane transparency on and rewind a song it gets rid of the transparency.

Describe your bug here.

It doesn't keep the value due to some math in the code I was able to fix it on my own using tools but would be nice to see it fixed entirely!

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Build is not modified.

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

No

Missing something for stage

What needs to be documented?

the shaders.hx should be added to add wavy bg or, if its not added, i think its not gonna work

stolen code without credit

What is your question?

if you're stealing code then add credit!!!!!

Softcoded Noteskins

What feature do you want to get added on the base engine?

I've noticed within Note.hx that the note skin selection is pretty easy to change, but of course it's with source. So I was wondering if the note skin can be changeable using files instead, making it softcoded.

Essentially what I think it would look like is that a noteskins.txt file would be in the data folder that defines all note skins that are selectable within the options. Than people could drop their custom arrow skins into the shared sprite folder (or somewhere else.)

To test your sight, and reliability, please select the option of what should NOT be requested.

Stage Editor, 6K+ support.

Note tails are visible in "Hide opponent notes in middlescroll" when they shouldn't.

Describe your bug here.

Note tails are visible, may I say more



?

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Source

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

No, I just downloaded the build.

More character editor customization.

What feature do you want to get added on the base engine?

Player offsets that will replace the original offsets when the character is selected as boyfriend. These can be edited whenever 'Playable Character' in the top right is checked.
Also add a checkbox that when checked, it will swap the singLEFT and singRIGHT animations if it's the boyfriend.
This makes it so much easier to create playable and enemy characters, instead of creating duplicates which take up a lot more space.

To test your sight, and reliability, please select the option of what should NOT be requested.

6K+ support.

"perfect" asset missing in pixel stages

Describe your bug here.

title says it all
i tried making one myself and naming the file "perfect-pixel" but nothing shows up

Command Prompt/Terminal logs (if existing)

No response

Are you modding a build from source or with Lua?

Lua

What is your build target?

Windows

Did you edit anything in this build? If so, mention or summarize your changes.

no

extra keys request

What feature do you want to get added on the base engine?

Add extra keys to the OS Engine, it would be helpful with the mod is creating NotExtrem bc it haves extra keys but we moved to this engine

To test your sight, and reliability, please select the option of what should NOT be requested.

Code optimization that would make the game faster. (You should make a PR if this is your request, by the way.)

Boyfriend Floating