Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
BombasticTom committed May 26, 2024
2 parents 0d077f3 + 4433034 commit 5fdbe09
Show file tree
Hide file tree
Showing 23 changed files with 440 additions and 213 deletions.
36 changes: 23 additions & 13 deletions .github/ISSUE_TEMPLATE/error.yml
Original file line number Diff line number Diff line change
@@ -1,36 +1,46 @@
name: Error
description: You need help resolving an error/crash in the converter
body:
- type: checkboxes
attributes:
label: Issue Checklist
options:
- label: I have properly named the issue
- label: I looked in issues/discussions, if my question was previously anwsered

- type: dropdown
attributes:
label: What is the preset selected?
options:
- Charts only
- Songs only
- Audio only
- Characters only
- Stages only
- Full mod
- I chose
validations:
required: true

- type: textarea
attributes:
label: If you chose what to convert, what did you pick? (if applicable)

- type: dropdown
attributes:
label: What platform?
options:
- Windows
- Mac
- Linux (Ubuntu)

- type: textarea
attributes:
label: What are the contents of the latest .log file? (if applicable)
label: What are the contents of the latest .log file? (If you don't know what the last log file was, open the ".defaults" file, where you will find the name of the log file in the third line.)

- type: textarea
attributes:
label: What are the contents of your mod folder? (if applicable)
label: What are the contents of your mod folder?

- type: textarea
attributes:
label: Additional Context (if applicable)
label: Additional Context

- type: checkboxes
attributes:
label: Issue Checklist
options:
- label: I have properly named the issue
- label: I looked in issues/discussions, if my question was previously anwsered

# based on https://github.com/LeleDerGrasshalmi/FortniteEndpointsDocumentation/blob/main/.github/ISSUE_TEMPLATE/api_error.yml
8 changes: 6 additions & 2 deletions .github/ISSUE_TEMPLATE/incomplete.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ body:
label: What is the preset selected?
options:
- Charts only
- Songs only
- Audio only
- Characters only
- Stages only
- Full mod
Expand All @@ -23,7 +23,11 @@ body:

- type: textarea
attributes:
label: What are the contents of the latest .log file? (if applicable)
label: If you chose what to convert, what did you pick? (if applicable)

- type: textarea
attributes:
label: What are the contents of the latest .log file? (if applicable) (If you don't know what the last log file was, open the ".defaults" file, where you will find the name of the log file in the third line.)

- type: textarea
attributes:
Expand Down
51 changes: 51 additions & 0 deletions .github/workflows/pr-builds.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: FNF Porter Build

on:
pull_request:
branches: [ "main" ]

permissions:
contents: read

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [windows-latest, macos-latest, ubuntu-latest]
include:
- os: windows-latest
icon: icon.ico
ext: .exe
- os: macos-latest
icon: icon.icns
ext:
- os: ubuntu-latest
icon: ""
ext:

steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Cache pip
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pyinstaller numpy pydub luaparser pyqt6 pillow
- name: Build with PyInstaller
run: |
pyinstaller --onefile psychtobase/main.py --icon=${{ matrix.icon }} --noconsole -n "FNF Porter pullrequest-${{ github.event.pull_request.number }}"
- name: Upload build artifact
uses: actions/upload-artifact@v4
with:
name: FNF_Porter_Build_${{ matrix.os }}
path: dist/*${{ matrix.ext }}
4 changes: 2 additions & 2 deletions .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pyinstaller numpy pydub luaparser pyqt6
pip install pyinstaller numpy pydub luaparser pyqt6 pillow
- name: Build with PyInstaller
run: |
pyinstaller --onefile setup.py --icon=${{ matrix.icon }} --noconsole -n "FNF Porter dev-${{ github.run_number }}"
pyinstaller --onefile psychtobase/main.py --icon=${{ matrix.icon }} --noconsole -n "FNF Porter actions-${{ github.run_number }}"
- name: Upload build artifact
uses: actions/upload-artifact@v4
with:
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,28 @@ Ports FNF mods between engines using Python. Right now, there's only support for
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.

## Issues?
Report it in the [issues tab](https://github.com/gusborg88/fnf-porter/issues/new?body=Log+file+output+(check+logs+folder):%0A```%0A%0A```).
Report it in the [issues tab](https://github.com/gusborg88/fnf-porter/issues/).

Check if it **already exists** before reporting though!

Also, logs are saved to your logs folder, so make sure to read them.

## Contributing
Thanks for contributing! You'll need to install [Python](https://www.python.org/downloads/) ofc, and the other dependencies listed in the next section. You can build after this by running [build.bat](build.bat). If you have questions about the code, ask Gusborg, tposejank, or BombasticTom.
Thanks for contributing! You'll need to install [Python](https://www.python.org/downloads/) ofc, and the other dependencies listed in the next section. You can build after this by running [build.bat](build.bat). If you have questions about the code, ask the team.

## 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
You can start the window by running setup.py.
You can start the window by running main.py

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.

## 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, and BombasticTom), and you can't make ANY money from it. Because this doens't use any assets from FNF, it's license doesn't apply here.
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 FNF, it's license doesn't apply here.

Read [LICENSE](https://github.com/gusborg88/fnf-porter/blob/main/LICENSE) for fancy legal words
2 changes: 1 addition & 1 deletion build.bat
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pyinstaller --onefile --icon=icon.ico -n "FNF Porter" setup.py
pyinstaller --onefile --icon=icon.ico -n "FNF Porter" psychtobase/main.py
cd dist
"FNF Porter.exe"
3 changes: 2 additions & 1 deletion dependency-install.bat
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ pip install pyinstaller
pip install numpy
pip install pydub
pip install luaparser
pip install pyqt6
pip install pyqt6
pip install pillow
Binary file removed error.png
Binary file not shown.
Loading

0 comments on commit 5fdbe09

Please sign in to comment.