9572b54d4b
I think this should be important to mention cuz most people dont really think of the docs folder as anything important.
85 lines
6.4 KiB
Markdown
85 lines
6.4 KiB
Markdown
|
|
|
|
|
|
[](https://ci.appveyor.com/project/KadeDev/kade-engine-windows/branch/master/artifacts) [](https://ci.appveyor.com/project/KadeDev/kade-engine-macos/branch/master/artifacts) [](https://ci.appveyor.com/project/KadeDev/kade-engine-linux/branch/master/artifacts) [](https://ci.appveyor.com/project/daniel11420/KadeEngineWeb) [](https://discord.gg/MG6GQFh52U) [](https://github.com/KadeDev/Kade-Engine/issues) [](https://github.com/KadeDev/Kade-Engine/pulls) []() []()
|
|
|
|
      
|
|
|
|
# Friday Night Funkin': Kade Engine
|
|
|
|
### If you want to contribute to Kade Engine, read [this](https://github.com/KadeDev/Kade-Engine/blob/stable/CONTRIBUTING.md) first.
|
|
### If you want to build Kade Engine, read [this](https://github.com/KadeDev/Kade-Engine/blob/stable/docs/building.md).
|
|
|
|
## Friday Night Funkin'
|
|
**Friday Night Funkin'** is a rhythm game originally made for Ludum Dare 47 "Stuck In a Loop".
|
|
|
|
Links: **[itch.io page](https://ninja-muffin24.itch.io/funkin) ⋅ [Newgrounds](https://www.newgrounds.com/portal/view/770371) ⋅ [source code on GitHub](https://github.com/ninjamuffin99/Funkin)**
|
|
> Uh oh! Your tryin to kiss ur hot girlfriend, but her MEAN and EVIL dad is trying to KILL you! He's an ex-rockstar, the only way to get to his heart? The power of music...
|
|
|
|
## Kade Engine
|
|
**Kade Engine** is a mod for Friday Night Funkin', including a full engine rework, replays, and more.
|
|
|
|
Links: **[GameBanana mod page](https://gamebanana.com/gamefiles/16761) ⋅ [play in browser](https://funkin.puyo.xyz) ⋅ [latest stable release](https://github.com/KadeDev/Kade-Engine/releases/latest) ⋅ [latest development build (windows)](https://ci.appveyor.com/project/KadeDev/kade-engine-windows/branch/master/artifacts) ⋅ [latest development build (macOS)](https://ci.appveyor.com/project/KadeDev/kade-engine-macos/branch/master/artifacts) ⋅ [latest development build (linux)](https://ci.appveyor.com/project/KadeDev/kade-engine-linux/branch/master/artifacts)**
|
|
|
|
**REMEMBER**: This is a **mod**. This is not the vanilla game and should be treated as a **modification**. This is not and probably will never be official, so don't get confused.
|
|
|
|
## Website ([KadeDev.github.io/kade-engine/](https://KadeDev.github.io/Kade-Engine/))
|
|
If you're looking for documentation, changelogs, or guides, you can find those on the Kade Engine website.
|
|
|
|
# Previews ([skip](#features))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Features
|
|
|
|
- **New Input System**
|
|
- An improved input system, similar to Quaver or Etterna, with less delays, less dropped inputs and other improvements.
|
|
- **More information during gameplay**
|
|
- While you're playing, we show you information about how you're doing, such as your accuracy, combo break count, notes per second, and your grade/rating.
|
|
- **Customizable keybinds**
|
|
- Instead of being forced to use WASD and the arrow keys, you can set any keybinds you want!
|
|
- **Replays** (in beta)
|
|
- Have you ever gotten a crazy score but didn't record? The replay system solves that: it automatically saves a "replay" of your gameplay every time you complete a song, which you can play back inside of the game.
|
|
- Replays just store information about what you're doing, they don't actually record the screen -- so they take up way less space on your disk than videos.
|
|
- **Audio offset**
|
|
- If your speakers or headphones are delayed, you can set an offset in the options menu to line the game up with the delay and play with synced audio like intended!
|
|
- **And much, much more!**
|
|
- There's so much more in store than just what's listed here! If you can imagine a quality of life feature, it's probably
|
|
either already included in Kade Engine or is being worked on!
|
|
|
|
# Credits
|
|
### Friday Night Funkin'
|
|
- [ninjamuffin99](https://twitter.com/ninja_muffin99) - Programming
|
|
- [PhantomArcade3K](https://twitter.com/phantomarcade3k) and [Evilsk8r](https://twitter.com/evilsk8r) - Art
|
|
- [Kawai Sprite](https://twitter.com/kawaisprite) - Music
|
|
|
|
This game was made with love to Newgrounds and its community. Extra love to Tom Fulp.
|
|
### Kade Engine
|
|
- [KadeDeveloper](https://twitter.com/KadeDeveloper) - Maintainer and lead programmer
|
|
- [The contributors](https://github.com/KadeDev/Kade-Engine/graphs/contributors)
|
|
|
|
|
|
|
|
### Shoutouts
|
|
- [GWebDev](https://github.com/GrowtopiaFli) - Video Code
|
|
- [Rozebud](https://github.com/ThatRozebudDude) - Ideas (that I stole)
|
|
- [Puyo](https://github.com/puyoxyz) - Setting up appveyor and a lot of other help
|
|
- [Smokey](https://github.com/Smokey555) - telling me that I should do the tricky asset loading
|
|
- [Poco](https://github.com/poco0317) - math degree (aka most of the fucking math in this project)
|