Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix some README mistakes #62

Merged
merged 2 commits into from
Jun 11, 2024
Merged

Fix some README mistakes #62

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa3b764
the english hurts me
CobaltBar Jun 11, 2024
ce91e33
spacing
CobaltBar Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
![Window icon](images/big-icon.webp)
# Friday Night Funkin' Mod Porter

Ports FNF mods between engines using Python. Right now, there's only support for Psych Engine to the Base Game, but new modes are coming soon! It has a GUI, cross-platform support, and logs (check the logs folder).
Ports FNF mods between engines using Python. Right now, there's only support for Psych Engine to the Base Game, but new modes are coming soon! It has a GUI, cross-platform support, and logs (check the `logs` folder).

## Download
Go to the [releases tab](https://github.com/gusborg88/fnf-porter/releases) for slightly older versions. Read the dependencies section if you want to build it yourself.

For an alternative stable source, use our [GameBanana](https://gamebanana.com/tools/16982)

For latest compilations, go to the [actions tab](https://github.com/gusborg88/fnf-porter/actions)
For latest builds, go to the [actions tab](https://github.com/gusborg88/fnf-porter/actions)

## Issues?
Report it in the [issues tab](https://github.com/gusborg88/fnf-porter/issues/).
Expand All @@ -22,23 +22,24 @@ Thanks for contributing! You'll need to install [Python](https://www.python.org/

## Dependencies
You can simply run `dependency-install.bat` to install all of these at once. You have to go to [python.org](https://www.python.org/downloads/) and get Python first, though.
- luaparser
- numpy
- pillow
- pydub
- pyinstaller
- PyQt6
- `luaparser`
- `numpy`
- `pillow`
- `pydub`
- `pyinstaller`
- `PyQt6`

You can start the window by running `psychtobase/main.py`,
or alternatively run `build.bat` to build the application yourself.

Note that your build won't have a signature/key/what ever you call it, so Windows Defender will probably delete it. Github actions makes builds that don't have this issue, so use these instead.
Note that your build won't be signed, so Windows Defender will probably delete it. Github actions make builds that don't have this issue, so use those instead.

## License
FNF Porter is licensed under CC-BY-NC 4.0. That means you can modify it, but you have to credit the authors (Gusborg, tposejank, BombasticTom & VocalFan), and you can't make ANY money from it. Because this doesn't use any assets from Funkin' Crew, their license doesn't apply here.

Read [LICENSE](LICENSE) for fancy legal words

This program uses FFmpeg, a free software made for manipulating all sorts of media throught codecs.
This program uses FFmpeg, a free software made for manipulating all sorts of media through codecs.
FFmpeg is protected under the LGPL v2.1 License.

Read [FFmpeg's license](FFMPEG-LICENSE)
Read [FFmpeg's license](FFMPEG-LICENSE)