|
2 | 2 |
|
3 | 3 | <sub>(aka Friday Night Funkin': Vs. Freya)</sub>
|
4 | 4 |
|
5 |
| - |
| 5 | + |
6 | 6 |
|
7 |
| -  |
| 7 | +[](https://github.com/VsFreyaDevs/VsFreyaModNew/actions/workflows/build-game-windows.yml) [](https://github.com/VsFreyaDevs/VsFreyaModNew/actions/workflows/build-gamewin32.yml) [](https://github.com/VsFreyaDevs/VsFreyaModNew/actions/workflows/build-game-linux.yml) [](https://github.com/VsFreyaDevs/VsFreyaModNew/actions/workflows/build-game-android.yml) [](https://github.com/VsFreyaDevs/VsFreyaModNew/actions/workflows/build-game-ios.yml) |
| 8 | + |
| 9 | +------------------------------------------------------------- |
| 10 | + |
| 11 | +   [](https://github.com/VsFreyaDevs/VsFreyaModNew/issues) [](https://github.com/VsFreyaDevs/VsFreyaModNew/stargazers) [](https://github.com/VsFreyaDevs/VsFreyaModNew/pulls) |
| 12 | + |
| 13 | +------------------------------------------------------------- |
| 14 | + |
| 15 | +## Table of Contents |
| 16 | + |
| 17 | +┃ [**`• About Vs. Freya`**](#about-vs-freya) ┃ [**`••• Credits`**](#vs-freya-credits) ┃ [**`• About Kitsune Engine`**](#about-kitsune-engine) ┃ [**`• Compiling`**](/docs/COMPILING.md)┃ [**`••• Trobuleshooting`**](/docs/troubleshooting.md)┃ [**`• Contributing to Vs. Freya`**](/docs/CONTRIBUTING.md)┃[**`• To-Do`**](/TODO.md)┃[**`••• Roadmap`**](#roadmap)┃[**`• Minimum Specs`**](#minimum-requirements)┃ [**`••• Supported Platforms`**](#supported-platforms)┃[**`••• Changelog`**](/CHANGELOG.md)┃[**`••• License`**](/LICENSE.md)┃ |
| 18 | + |
| 19 | +------------------------------------------------------------- |
8 | 20 |
|
9 | 21 | ### About Vs. Freya
|
10 | 22 |
|
11 | 23 | A kitsune version of BF was walking in the kit world when he stumbles upon [FreyaFennec_foxes](https://www.youtube.com/@Freyafennec_foxes1.0) and her crew. Turns out this version of BF is actually a Freya hater and simps for [Mika_kit](https://www.youtube.com/@Mika_Kit162). He rap battles them under one condition: if he wins, he kills her.
|
12 | 24 |
|
13 |
| -## Kitsune Engine |
| 25 | +### Vs. Freya Credits |
| 26 | + |
| 27 | +#### Directors |
| 28 | + |
| 29 | +* [charlesisfeline](https://www.youtube.com/@charlescatyt) - Lead Director, Artist, Animator, Programmer, Musician, and Main Charter |
| 30 | +* [FreyaFennec_foxes a.k.a fries](https://www.tiktok.com/@sandythebestclown) - Co-Director, Concept Artist, uhhhh creator of the titular fox, Freya herself!!!!!! |
| 31 | +* [TheAnimateMan](https://www.youtube.com/channel/UCwsHVR5zkvnW4U4-Uoh118w) - Co-Director, Artist, Animator, and Musician |
| 32 | + |
| 33 | +#### Art / Animation |
| 34 | + |
| 35 | +* Rem-ix - Idea Guy or smth, Concept Art |
| 36 | +* KaciPuppi - Sprites for Mika (All-Stars cover) |
| 37 | +* [Sp1](https://x.com/Sp1_64) - Artist |
| 38 | + |
| 39 | +#### Charting |
| 40 | + |
| 41 | +* [Neo a.k.a Vencerist](https://www.youtube.com/@VencerVents) - Charter and Musician |
| 42 | + |
| 43 | +#### Programmers |
| 44 | + |
| 45 | +* [Moxie](https://github.com/moxie-coder) - Additional Programming |
| 46 | +* [Our contributors on GitHub](https://github.com/VsFreyaDevs/VsFreyaModNew/graphs/contributors) |
| 47 | + |
| 48 | +#### Musicians |
| 49 | + |
| 50 | +* [Isaiah Mods Official](https://www.youtube.com/channel/UCeILJmD-UdDIqI86eadDCZQ) - Musician and Artist |
| 51 | + |
| 52 | +#### Special Thanks |
| 53 | + |
| 54 | +* [mushroomchoir](https://mushroomchoir.newgrounds.com/) - Concept Art for GF_kit |
| 55 | + |
| 56 | +## About Kitsune Engine |
14 | 57 |
|
15 | 58 | Kitsune Engine is a fork of [Friday Night Funkin' (v0.5.x+)](https://github.com/FunkinCrew/Funkin) made to fix some problems the base game had while keeping the casual aspect of said game.
|
16 | 59 |
|
17 | 60 | Kitsune Engine is an *engine* that's basically like those old engines from 2021-2022, only refactoring some of FNF's code and serving as an option for people who want more settings and customizability while keeping up with the latest base FNF updates.
|
18 | 61 |
|
| 62 | +------------------------------------------------------------- |
| 63 | + |
| 64 | +> [!NOTE] |
| 65 | +> ***Kitsune Engine has not been finished just yet!*** While yes, you*can* port your V-Slice/Base Game mods over, you may however have to just make some changes to make your mod compatible to KSE. |
| 66 | +
|
| 67 | +------------------------------------------------------------- |
| 68 | + |
19 | 69 | * [Download builds for Windows, Mac, Linux, iOS, and Android here!](https://github.com/VsFreyaDevs/VsFreyaModNew/actions)
|
20 | 70 |
|
21 |
| -### Supported Platforms |
| 71 | +### Roadmap |
| 72 | + |
| 73 | +* [ ] Move away from GitHub to git.gay |
| 74 | +* [ ] Complete the mod!!! |
| 75 | +* [ ] Fix minor annoyances/bugs |
| 76 | + |
| 77 | +### Minimum Requirements |
| 78 | + |
| 79 | +TODO: add recommended spec stuff |
| 80 | + |
| 81 | +idk what cpu or gpu would have the game run *perfectly* so pls tell me if you do |
22 | 82 |
|
23 |
| -* **Windows** (32-bit & 64-bit!) |
24 |
| -* **MacOS** (x86_64 and arm64 only) |
25 |
| -* **Linux** |
26 |
| -* ~~**HTML5**~~ |
27 |
| -* **Android** (arm64, armv7a, x86, and x86_64 only) |
28 |
| -* **iOS** (arm64 and simulator only) |
29 |
| -* ~~**Hashlink(?)**~~ |
| 83 | +> [!tip] |
| 84 | +> Any game's performance may decrease with higher resolutions if your PC's kinda shitty. |
| 85 | +> Disable fullscreen and resize the game if encountering performance issues. |
30 | 86 |
|
31 |
| -NEKO AND FLASH ISNT SUPPORTED BITCHASS |
| 87 | +These should be the lowest minimum spec requirements to run the game: |
| 88 | + |
| 89 | +* **Processor** - Intel Celeron (SSE to SSE4 with MMX) or Higher |
| 90 | +* **Memory** - 2 GB of RAM (cuz uhhh memory leaks), idk about vram/gpu tho |
| 91 | +* **Storage** - ~1 GB of Available Disk Space |
| 92 | + |
| 93 | +#### Supported Platforms |
| 94 | + |
| 95 | +* **Windows (7 and up)** (32-bit & 64-bit) |
| 96 | +* **MacOS (UNTESTED)** (x86_64 and arm64 only) |
| 97 | +* **Linux (UNTESTED)** |
| 98 | +* ~~**HTML5 (UNTESTED)**~~ (TODO: re-add html5 support) |
| 99 | +* **Android (UNTESTED)** (arm64, armv7a, x86, and x86_64 only) |
| 100 | +* **iOS (UNTESTED)** (arm64 and simulator only) |
| 101 | +* ~~**Hashlink (UNTESTED)**~~ |
| 102 | + |
| 103 | +> [!NOTE] |
| 104 | +> NEKO AND FLASH ISNT SUPPORTED BITCHASS |
| 105 | +
|
| 106 | +------------------------------------------------------------- |
32 | 107 |
|
33 | 108 | # Friday Night Funkin'
|
34 | 109 |
|
35 |
| -Friday Night Funkin' is a rhythm game. Built using HaxeFlixel for Ludum Dare 47. |
| 110 | +Friday Night Funkin' is a rhythm game. Built using HaxeFlixel, originally for Ludum Dare 47: "Stuck In a Loop". |
36 | 111 |
|
37 | 112 | This game was made with love to Newgrounds and its community. Extra love to Tom Fulp.
|
38 | 113 |
|
| 114 | +> 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... |
| 115 | +
|
| 116 | +------------------------------------------------------------- |
| 117 | + |
| 118 | +* [base game source code in case lol!!!](https://github.com/ninjamuffin99/Funkin)** |
39 | 119 | * [Playable web demo on Newgrounds!](https://www.newgrounds.com/portal/view/770371)
|
40 | 120 | * [Demo download builds for Windows, Mac, and Linux from Itch.io!](https://ninja-muffin24.itch.io/funkin)
|
41 | 121 |
|
42 | 122 | ## Getting Started
|
43 | 123 |
|
44 |
| -**PLEASE USE THE LINKS ABOVE IF YOU JUST WANT TO PLAY THE GAME!!!** |
| 124 | +> [!NOTE] |
| 125 | +> **PLEASE USE THE LINKS ABOVE IF YOU JUST WANT TO PLAY THE GAME!!!** |
| 126 | +
|
| 127 | +------------------------------------------------------------- |
45 | 128 |
|
46 | 129 | To learn how to install the necessary dependencies and compile the game from source, please check out our [building the game](/docs/COMPILING.md) guide.
|
47 | 130 |
|
|
0 commit comments