From 4d2c80e28a2b474576183ea4874940a30b451ceb Mon Sep 17 00:00:00 2001 From: The Blob SCP <81673375+theblobscp@users.noreply.github.com> Date: Sun, 12 Sep 2021 19:14:20 -0400 Subject: [PATCH] First attempt at making an original readme --- README.md | 66 ++++++++++--------------------------------------------- 1 file changed, 11 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 832467c..1f99a25 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,14 @@ - ![Kade Engine logo](assets/preload/images/KadeEngineLogo.png) -[![AppVeyor](https://img.shields.io/appveyor/build/KadeDev/Kade-Engine-Windows?label=windows%20build)](https://ci.appveyor.com/project/KadeDev/kade-engine-windows/branch/master/artifacts) [![AppVeyor](https://img.shields.io/appveyor/build/KadeDev/Kade-Engine-Macos?label=macOS%20build)](https://ci.appveyor.com/project/KadeDev/kade-engine-macos/branch/master/artifacts) [![AppVeyor](https://img.shields.io/appveyor/build/KadeDev/Kade-Engine-Linux?label=linux%20build)](https://ci.appveyor.com/project/KadeDev/kade-engine-linux/branch/master/artifacts) [![AppVeyor](https://img.shields.io/appveyor/build/daniel11420/KadeEngineWeb?label=html5&20build)](https://ci.appveyor.com/project/daniel11420/KadeEngineWeb) [![Discord](https://img.shields.io/discord/808039740464300104?label=discord)](https://discord.gg/MG6GQFh52U) [![GitHub issues](https://img.shields.io/github/issues/KadeDev/Kade-Engine)](https://github.com/KadeDev/Kade-Engine/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/KadeDev/Kade-Engine)](https://github.com/KadeDev/Kade-Engine/pulls) []() []() - -![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/KadeDev/Kade-Engine/latest) ![GitHub repo size](https://img.shields.io/github/repo-size/KadeDev/Kade-Engine) ![Lines of code](https://img.shields.io/tokei/lines/github/KadeDev/Kade-Engine) ![Supported platforms](https://img.shields.io/badge/supported%20platforms-windows%2C%20macOS%2C%20linux%2C%20html5-blue) ![GitHub all releases](https://img.shields.io/github/downloads/KadeDev/Kade-Engine/total) ![GitHub](https://img.shields.io/github/license/KadeDev/Kade-Engine) ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/KadeDev/Kade-Engine?include_prereleases&label=latest%20version) - -# Friday Night Funkin': Kade Engine -## 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. +[![GitHub issues](https://img.shields.io/github/issues/StampSz/Dusttale-Source-Code)](https://github.com/StampSz/Dusttale-Source-Code/issues) +[![GitHub pull requests](https://img.shields.io/github/issues-pr/StampSz/Dusttale-Source-Code)](https://github.com/KadeDev/Kade-Engine/pulls) +![GitHub repo size](https://img.shields.io/github/repo-size/StampSz/Dusttale-Source-Code) +![Supported platforms](https://img.shields.io/badge/supported%20platforms-windows%2C%20macOS%2C%20linux%2C%20html5-blue) +![GitHub License](https://img.shields.io/github/license/StampSz/Dusttale-Source-Code) -# Previews ([skip](#features)) +# Friday Night Funkin': Dusttale +A Friday Night Funkin mod for your favorite murderer sans. -![Tutorial (Hard) on Downscroll](https://user-images.githubusercontent.com/15311104/113989685-fa5aea80-9850-11eb-9180-f5819a774c79.gif) ![Milf (Hard) on Downscroll](https://user-images.githubusercontent.com/15311104/113990845-2c208100-9852-11eb-8e6d-f1c9e8439871.gif) - -![Roses (Hard) on Upscroll](https://user-images.githubusercontent.com/15311104/113993573-e31dfc00-9854-11eb-82ae-1f29dc8a0b04.png) - -![Milf (Hard) on Downscroll](https://user-images.githubusercontent.com/15311104/113991654-f4660900-9852-11eb-8c3d-f3927571f19b.png) - -![He malding](https://user-images.githubusercontent.com/15311104/113993693-02b52480-9855-11eb-9975-eb8a7a1be8d1.png) - -![Free Play selection screen](https://i.imgur.com/LR0eWIC.png) - -![Options Menu](https://i.imgur.com/LBXW9C1.png) - -# 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 customize the keybinds to any keys 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 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. # Credits ### Friday Night Funkin' @@ -57,12 +17,8 @@ If you're looking for documentation, changelogs, or guides, you can find those o - [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/daniel11420) - Setting up appveyor and a lot of other help \ No newline at end of file +### Dusttale + - [WassabiSoja](https://github.com/WassabiSoja) + - [StampSz](https://github.com/StampSz) + - [hexar01](https://github.com/hexar01)