Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/KadeDev/Kade-Engine into …
Browse files Browse the repository at this point in the history
…KadeDev-master
  • Loading branch information
JOELwindows7 committed May 14, 2021
2 parents fbcf5ed + 2b41e5f commit 21b226c
Show file tree
Hide file tree
Showing 30 changed files with 1,203 additions and 924 deletions.
22 changes: 22 additions & 0 deletions ISSUES-WITH-ISSUES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Addressing Various Topics Related to Issues &/Or Discussions

Read this before making an issue. It pretty much just tells you what and what not to complain about.
## Issues

### What should go in an issue?
An issue should adhere to one of the two templates, Bug Report or Enhancement. (You can also create from blank but meh)

An issue should NOT be related to any problems in forks or mods of Kade Engine.

What the individual issue templates are for is self-explanatory, but please ACTUALLY use them. Don't just leave them blank and put all or partial info in the title.


## Discussions

### What should go in a discussion?
Discussions should be related to mods or forks of Kade Engine, as well as topics related to building the game from source.

> issues are for suggestions/bugs with kade engine itself, not with forks/mods of it.

This whole thing was made by Prokube's head and a comment by daniel11420.
13 changes: 0 additions & 13 deletions Modding.md

This file was deleted.

2 changes: 1 addition & 1 deletion Project.xml
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
<assets path='art/readme.txt' rename='do NOT readme.txt' />
<!-- <template path='mods' /> -->

<assets path="CHANGELOG.md" rename='changelog.txt'/>
<!-- <assets path="CHANGELOG.md" rename='changelog.txt'/> -->

<!-- NOTE FOR FUTURE SELF SINCE FONTS ARE ALWAYS FUCKY
TO FIX ONE OF THEM, I CONVERTED IT TO OTF. DUNNO IF YOU NEED TO
Expand Down
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@ Links: **[itch.io page](https://ninja-muffin24.itch.io/funkin) ⋅ [Newgrounds](
## 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/build/artifacts)[latest development build (macOS)](https://ci.appveyor.com/project/KadeDev/kade-engine-macos/build/artifacts)****[latest development build (linux)](https://ci.appveyor.com/project/KadeDev/kade-engine-linux/build/artifacts)**
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/build/artifacts)[latest development build (macOS)](https://ci.appveyor.com/project/KadeDev/kade-engine-macos/build/artifacts)[latest development build (linux)](https://ci.appveyor.com/project/KadeDev/kade-engine-linux/build/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.

# Screenshots ([skip](#features))

![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)
Expand Down Expand Up @@ -62,9 +65,3 @@ This game was made with love to Newgrounds and its community. Extra love to Tom
### Kade Engine
- [KadeDeveloper](https://twitter.com/KadeDeveloper) - Maintainer and lead programmer
- [The contributors](https://github.com/KadeDev/Kade-Engine/graphs/contributors)

# Other pages
- [BUILDING.md](https://github.com/KadeDev/Kade-Engine/blob/master/BUILDING.md) - How to compile/build the game
- [ModCharts.md](https://github.com/KadeDev/Kade-Engine/blob/master/ModCharts.md) - Mod Chart Documentation
- [CREDIT.md](https://github.com/KadeDev/Kade-Engine/blob/master/CREDIT.md) - additional credit big shoutouts
- [CRITICISM.md](https://github.com/KadeDev/Kade-Engine/blob/master/CRITICISM.md) - Criticism & appreciations of FNF and the communities
Binary file added assets/preload/images/KadeEngineLogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

7 changes: 7 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
theme: jekyll-theme-minimal
title: "Kade Engine"
description: "Kade Engine is a mod for Friday Night Funkin', including a full engine rework, replays, and more."
show_downloads: true
replace_index_with: "https://cors-thing.puyo.workers.dev/master/"
logo: "https://github.com/KadeDev/Kade-Engine/raw/master/KadeEngineLogo.png"
url: "https://KadeDev.github.io/Kade-Engine/"
34 changes: 34 additions & 0 deletions docs/_includes/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<style>
.headerlink {
background-color: #555;
color: white;
float: none;
border: none;
border-style: none;
outline: none;
cursor: pointer;
padding: 14px 16px;
font-size: 17px;
}

.headerlink:hover {
background-color: #777;
color: white;
}

hr {
height: 2px !important;
color: #555 !important;
background-color: #555 !important;
}
</style>
<center>
<p id="HtmlIsTheWorstThingIHaveEverUsed">
<a class="headerlink" href="{{site.url}}changelogs/">Changelogs</a>
<a class="headerlink" href="{{site.url}}building">Building</a>
<a class="headerlink" href="{{site.url}}modchart">Modcharts</a>
<a class="headerlink" href="{{site.url}}guides">Guides</a>
<br>&nbsp;
<hr>
</p>
</center>
93 changes: 93 additions & 0 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<!DOCTYPE html>
<html lang="{{ site.lang | default: "en-US" }}">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{{page.title}} - Kade Engine</title>

{% seo %}
<link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
<!--[if lt IE 9]>
<script src="https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
<![endif]-->
</head>
<body>
<div class="wrapper">
<header>
<h1><a href="{{ site.url }}">{{ site.title | default: site.github.repository_name }}</a></h1>

{% if site.logo %}
<img src="{{site.logo | relative_url}}" alt="Logo" />
{% endif %}

<p>{{ site.description | default: site.github.project_tagline }}</p>

{% if site.github.is_project_page %}
<p class="view"><a href="{{ site.github.repository_url }}">View the Project on GitHub <small>{{ site.github.repository_nwo }}</small></a></p>
{% endif %}

{% if site.github.is_user_page %}
<p class="view"><a href="{{ site.github.owner_url }}">View My GitHub Profile</a></p>
{% endif %}

{% if site.show_downloads %}
<p>
<small>Source code</small>
<ul class="downloads">
<li><a href="{{ site.github.zip_url }}">Download <strong>ZIP File</strong></a></li>
<li><a href="{{ site.github.tar_url }}">Download <strong>TAR Ball</strong></a></li>
<li><a href="{{ site.github.repository_url }}">View On <strong>GitHub</strong></a></li>
</ul>
</p>
<p>
<small>Binaries</small><br>
<a href="https://github.com/KadeDev/Kade-Engine/releases/latest">Download the <b>Latest release</b></a><br>
<a href="https://ci.appveyor.com/project/KadeDev/kade-engine-windows/build/artifacts">Download a <b>Windows</b> development build</a><br>
<a href="https://ci.appveyor.com/project/KadeDev/kade-engine-linux/build/artifacts">Download a <b>Linux</b> development build</a><br>
<a href="https://funkin.puyo.xyz/nightly/">Play in your <b>Web Browser</b></a>
</p>
{% endif %}
</header>
<section id="content">
{% include header.html %}
{% if page.url == "/" %}
<!-- yay i'm NOT stupid -->
{% else %}
{{ content }}
{% endif %}

</section>
<footer>
{% if site.github.is_project_page %}
<p>This project is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
{% endif %}
<p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
</footer>
</div>
<script src="{{ "/assets/js/scale.fix.js" | relative_url }}"></script>
{% if page.url == "/" %}
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
<script>
function httpGet(theUrl)
{
var xmlHttp = new XMLHttpRequest();
xmlHttp.open( "GET", theUrl, false ); // false for synchronous request
xmlHttp.send( null );
return xmlHttp.responseText;
}
document.getElementById('content').innerHTML = document.getElementById('content').innerHTML + marked(httpGet("{{ site.replace_index_with }}"));
</script>
{% endif %}
{% if site.google_analytics %}
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', '{{ site.google_analytics }}', 'auto');
ga('send', 'pageview');
</script>
{% endif %}
</body>
</html>
10 changes: 6 additions & 4 deletions BUILDING.md → docs/building.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Building Friday Night Funkin': Kade Engine

**Please note** that these instructions are for compiling/building the game. If you just want to play Kade Engine, **play in your browser or download a build instead**: **[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/build/artifacts)[latest development build (linux)](https://ci.appveyor.com/project/daniel11420/kade-engine-linux/build/artifacts)**. If you want to build the game yourself, continue reading.
**Please note** that these instructions are for compiling/building the game. If you just want to play Kade Engine, **play in your browser or download a build instead**: **[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/build/artifacts)[latest development build (macOS)](https://ci.appveyor.com/project/daniel11420/kade-engine-macos/build/artifacts)[latest development build (linux)](https://ci.appveyor.com/project/daniel11420/kade-engine-linux/build/artifacts)**. If you want to build the game yourself, continue reading.

**Also note**: you should be familiar with the commandline. If not, read this [quick guide by ninjamuffin](https://ninjamuffin99.newgrounds.com/news/post/1090480).

Expand Down Expand Up @@ -28,6 +28,7 @@
- `haxelib git faxe https://github.com/uhrobots/faxe`
- `haxelib git polymod https://github.com/larsiusprime/polymod.git`
- `haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc`

### Windows-only dependencies (only for building *to* Windows. Building html5 on Windows does not require this)
If you are planning to build for Windows, you also need to install **Visual Studio 2019**. While installing it, *don't click on any of the options to install workloads*. Instead, go to the **individual components** tab and choose the following:
- MSVC v142 - VS 2019 C++ x64/x86 build tools
Expand Down Expand Up @@ -57,10 +58,11 @@ Since you already installed `git` in a previous step, we'll use it to clone the
2. `git clone https://github.com/KadeDev/Kade-Engine.git`
3. `cd` into the source code: `cd Kade-Engine`
4. (optional) If you want to build a specific version of Kade Engine, you can use `git checkout` to switch to it (i.e. `git checkout 1.4-KE`) (remember that versions 1.4 and older cannot build to Linux or HTML5)
- You should **not** do this if you are planning to contribute, as you should always be developing on the latest version.
- You should **not** do this if you are planning to contribute, as you should always be developing on the latest version.

## Building
Finally, we are ready to build.

- Run `lime build <target>`, replacing `<target>` with the platform you want to build to (`windows`, `linux`, `html5`) (i.e. `lime build windows`)
- Run `lime build <target>`, replacing `<target>` with the platform you want to build to (`windows`, `mac`, `linux`, `html5`) (i.e. `lime build windows`)
- The build will be in `Kade-Engine/export/<target>/bin`, with `<target>` being the target you built to in the previous step. (i.e. `Kade-Engine/export/windows/bin`)
- Only the `bin` folder is necessary to run the game. The other ones in `export/<target>` are not.
- Only the `bin` folder is necessary to run the game. The other ones in `export/<target>` are not.
4 changes: 2 additions & 2 deletions CHANGELOG.md → docs/changelogs/changelog-pre.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changelog
All notable changes will be documented in this file.
# Changelog for 1.4.2 and before
Changelogs from before the current changelog system existed.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Expand Down
24 changes: 24 additions & 0 deletions docs/changelogs/changelog-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Latest changelog/Changelog for 1.0.0

Changes marked with 💖 will be listed in the short version of the changelog in `version.downloadMe`.

### Additions
- New thing without issue
- [#1](https://github.com/KadeDev/Kade-Engine/issues/1): New thing with issue
- [#1](https://github.com/KadeDev/Kade-Engine/issues/1) ([PR #1](https://github.com/KadeDev/Kade-Engine/pulls/1)): New thing with issue and pull request
- [PR #1](https://github.com/KadeDev/Kade-Engine/pulls/1): New thing with pull request but no issue
- 💖 [PR #1](https://github.com/KadeDev/Kade-Engine/pulls/1): New thing with pull request but no issue and it's going in the short changelog

### Changes
- Use same templates as additions
- Changes also includes stuff getting removed (as that happens less often so include it with changes)

### Bugfixes
- Use same templates as additions
- This is for when bugs get fixed. This should, like, always have an issue link, most of the time (if it has one)

## Links
[GitHub Release](https://github.com/KadeDev/Kade-Engine/releases/tag/1.4.2) · [Last Windows CI build]() · [Last macOS CI build]() · [Last Linux CI build]()

// Only include links section after it is no longer "latest changelog"
// "Last x CI build" links should link to a specific build, the last one for the version
4 changes: 4 additions & 0 deletions docs/changelogs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Changelogs

- [Latest](latest) (Contains changes that are not in a release yet)
- [1.4.2 and before](changelog-pre)
39 changes: 39 additions & 0 deletions docs/changelogs/latest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Latest changelog

Changes marked with 💖 will be listed in the short version of the changelog in `version.downloadMe`.

### Additions
- [PR #307](https://github.com/KadeDev/Kade-Engine/pulls/307): Fix freeplay lag, add freeplay background changes, and add icons updating in charting state
- Updated to Week 7 input with anti mash
- 💖 Added toggle for ghost tapping
- 💖 [PR #328](https://github.com/KadeDev/Kade-Engine/pulls/328) and [PR #331](https://github.com/KadeDev/Kade-Engine/pulls/331): Distractions toggle
- [PR #341](https://github.com/KadeDev/Kade-Engine/pull/341): Update heads in realtime in charting state
- 💖 [PR #362](https://github.com/KadeDev/Kade-Engine/pull/362): Officially support macOS (and add macOS requirements to docs)
- Set up macOS CI builds
- [PR #373](https://github.com/KadeDev/Kade-Engine/pull/373): Add tweens to modcharts
- [PR #367](https://github.com/KadeDev/Kade-Engine/pull/367): Add labels to charting state
- [PR #374](https://github.com/KadeDev/Kade-Engine/pull/374): Add more icon sizes
- 💖 [PR #385](https://github.com/KadeDev/Kade-Engine/pull/385): Autoplay
- (maybe 💖) [#353](https://github.com/KadeDev/Kade-Engine/issues/353) ([PR #400](https://github.com/KadeDev/Kade-Engine/pulls/400)): Clap assist for syncing charts
- [PR #413](https://github.com/KadeDev/Kade-Engine/pulls/413): Option to disable flashing lights in menus
- [PR #428](https://github.com/KadeDev/Kade-Engine/pulls/428): Move documentation to GitHub Pages + new changelog system
- [PR #431](https://github.com/KadeDev/Kade-Engine/pull/431): Add Max NPS counter

### Changes
- Tutorial is now a modchart instead of being hardcoded
- [PR #332](https://github.com/KadeDev/Kade-Engine/pull/332): Move the beatbox in Fresh to the vocal track
- [PR #334](https://github.com/KadeDev/Kade-Engine/pull/334): Unhardcode GF Version, stages, and noteskins and make them loaded from chart
- [PR #291](https://github.com/KadeDev/Kade-Engine/pull/291): Make it so you can compile with 4.0.x
- 💖 [PR #440](https://github.com/KadeDev/Kade-Engine/pull/440): Change how replays work + store scroll speed and direction in replays

### Bugfixes
- [PR #289](https://github.com/KadeDev/Kade-Engine/pulls/289): Player 2 now plays idle animation properly when camera zooms in
- (maybe 💖) [PR #314](https://github.com/KadeDev/Kade-Engine/pulls/314): Fix note trails
- [PR #330](https://github.com/KadeDev/Kade-Engine/pull/330): Fix spelling errors in options
- [#329](https://github.com/KadeDev/Kade-Engine/issues/329) ([PR #341](https://github.com/KadeDev/Kade-Engine/pull/341)): Fix crash when changing characters in charting state on web
- [PR #341](https://github.com/KadeDev/Kade-Engine/pull/341): Fix html5 crash (when building), fix layering issues in charting state, fix charting state crashes in html5
- [PR #376](https://github.com/KadeDev/Kade-Engine/pull/376): Fix must hit sections
- [#368](https://github.com/KadeDev/Kade-Engine/issues/368) ([PR #392](https://github.com/KadeDev/Kade-Engine/pull/392)): Fix enemy idle animations not playing before first note
- [PR #399](https://github.com/KadeDev/Kade-Engine/pulls/399): Fix downscroll typo
- [PR #431](https://github.com/KadeDev/Kade-Engine/pull/431): Fix NPS counter
- [#404](https://github.com/KadeDev/Kade-Engine/issues/404) ([PR #446](https://github.com/KadeDev/Kade-Engine/pull/446)): Fix bug where Alt Animation in charting state doesn't stay checked after going to another section then back
10 changes: 10 additions & 0 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Guides
[Creating A Custom Week](https://kadedev.github.io/Funkin/guides/weeks)

### Contributing
If you'd like to write a guide, you can make a [pull request](https://github.com/KadeDev/Kade-Engine/pulls). Make sure you put the guide in `docs/guides/` and that it's written in Markdown.

Guides that need to be written:
- How to use the charting state/chart editor
- How to make custom dialogue (like Week 6)
- How to make custom characters
Loading

0 comments on commit 21b226c

Please sign in to comment.