Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
reithegoat committed Oct 10, 2021
2 parents 5c4b284 + bccbb5c commit cb8f0ec
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
FridayNight
**Unity Party** is an FNF' engine created using the Unity game engine focused on allowing lower-end PCs to play FNF'.

## Note Worthy Features
### High FPS
Thanks to Unity, the game is able to run better on lower-end PCs than HaxeFlixel. You can modify the engine's source code to do complicated effects that might cause some lower-end PCs to struggle when done on HaxeFlixel, though you can replicate the effects in Unity and lower-end PCs will run it fine.
### Control Mapping
You can remap your keybinds to any key on your keyboard, but you also have a SECONDARY keybind list that you can use to at any time without having to manually switch it all the time!
### Two Player Mode
The engine natively supports two-player. You and the other player play on the same keyboard. Keybinds for both players are also modifiable.
If the game is set to Two Player Mode, primary keybinds are used for player one and secondary keybinds are used for player two.
### Song Bundles
Bundles are a collection of songs that each can possibly contain custom scripting. Each song in a bundle can contain information such as artist name, charter name, and even an album cover. Bundles can be exported to a .ZIP format and easily shared. If applicable, users can download bundles if they have the download URL via the in-game bundle downloader. Bundles are almost always forward-compatible with future versions of the engine.
### AutoPlay
You just wanna see how that one song is played out? The engine can autoplay any song for you. This depends on your PC's performance, however. Meaning lower performance, the less accurate the AutoPlay will be, but usually AutoPlay will be precise.
### Note Color Customization
This is also a kind of support for the colorblind! You can customize the color of each of the 4 note keys to any color you want, even pure black!
### Offset System
You can test and change your offset for both inputs and notes.
### Sound Channels
Are some voices or music too loud? What if the music is too loud but the voices are not? That's okay, you can choose which sound to turn down separately!

## Requirements for Editing and Building
You will need the Unity Editor and an IDE that can support Unity.

I recommend you install Unity **2019.4.28 or newer** and Visual Studio **Community Edition**. Visual Studio Code can work, and if you wanna be fancy then you could purchase JetBrains Rider.

[How to build for Windows, Linux, and macOS](https://docs.unity3d.com/2019.4/Documentation/Manual/BuildSettingsStandalone.html)

Also, Unity has an entire manual and C# documentation available online and offline, when selected for download while downloading the Unity Editor.

If you wanna check it out, [it's here!](https://docs.unity3d.com/2019.4/Documentation/Manual/UnityManual.html)

There is no guide as of yet to help with how to do specific things, unfortunately. No sure when we'll make guides for those.

0 comments on commit cb8f0ec

Please sign in to comment.