1
0
Fork 0
mirror of https://github.com/jugeeya/UltimateTrainingModpack.git synced 2025-03-02 04:48:22 +00:00

Remove references to Ryujinx and emulator installation (#703)

This commit is contained in:
asimon-1 2024-10-07 09:40:06 -07:00 committed by GitHub
parent 254578982b
commit 83cd079352
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 0 additions and 153 deletions

2
.gitattributes vendored
View file

@ -1,4 +1,2 @@
.devcontainer/** linguist-vendored
.vscode/** linguist-vendored
ryujinx_build.ps1 linguist-vendored
ryujinx_build.sh linguist-vendored

View file

@ -178,38 +178,6 @@ jobs:
├── libparam_hook.nro
└── libtraining_modpack.nro
```
### Installation on Ryujinx Emulator on PC
Exact same process as above, but the filepaths are in Ryujinx's mod paths.
1) Extract the contents of the TrainingModpack .zip (`atmosphere` folder). Within that folder, you'll have a `contents` folder. Paste the `contents` folder inside atmosphere into `%AppData%/Ryujinx/mods/`.
2) Similarly, extracted contents of the Skyline .zip (`exefs` folder) into into `%AppData%/Ryujinx/mods/contents/01006a800016e000`.
3) No files need to be manually deleted when upgrading from a previous version.
4) The Ryujinx mods folder should have the files below at these locations.
```
%AppData%
└── Ryujinx/
└── mods/
└── contents/
└── 01006A800016E000/
├── exefs/
│ ├── subsdk9
│ └── main.npdm
└── romfs/
└── skyline/
└── plugins/
├── libnro_hook.nro
├── libparam_hook.nro
└── libtraining_modpack.nro
```
files: >
training_modpack_beta.zip
- name: Upload zip as artifact

View file

@ -307,31 +307,6 @@ SD Card Root
└── libtraining_modpack.nro
```
## Installation on Ryujinx Emulator on PC
Exact same process as above, but the filepaths are in Ryujinx's mod paths.
1) Extract the contents of the TrainingModpack .zip (`atmosphere` folder). Within that folder, you'll have a `contents` folder. Paste the `contents` folder inside atmosphere into `%AppData%/Ryujinx/mods/`.
2) Similarly, extracted contents of the Skyline .zip (`exefs` folder) into into `%AppData%/Ryujinx/mods/contents/01006a800016e000`.
3) No files need to be manually deleted when upgrading from a previous version.
4) The Ryujinx mods folder should have the files below at these locations.
```
%AppData%
└── Ryujinx/
└── mods/
└── contents/
└── 01006A800016E000/
├── exefs/
│ ├── subsdk9
│ └── main.npdm
└── romfs/
└── skyline/
└── plugins/
├── libnro_hook.nro
├── libparam_hook.nro
└── libtraining_modpack.nro
```
## Beta Installation
To install a beta version of the modpack, follow the same procedure using the [latest beta release](https://github.com/jugeeya/UltimateTrainingModpack/tree/beta) on Github. Beta releases may have additional features and bugfixes, but are subject to change.
@ -358,9 +333,7 @@ To install a beta version of the modpack, follow the same procedure using the [l
6. **Do I need an emuMMC?**
No, an emuMMC is not required for smash mods. Using an emuMMC is complicated and a known ban risk when connected online, so it is not recommended.
7. **Can this mod be run on emulators?**
Yes, using Yuzu or Ryujinx! See the installation instructions for more information.
8. **How do I know that I installed the Training Modpack correctly?**
When launching Smash for the first time after installing the Training Modpack, you should receive a pop up notification confirming that you've installed it correctly. You can also check your SD card to make sure that you have all of the files installed in the correct location. If you have the following files, its likely that everything else is installed correctly as well. `SD:/atmosphere/contents/01006A800016E000/exefs/main.npdm`, `SD:/atmosphere/contents/01006A800016E000/romfs/skyline/plugins/libtraining_modpack.nro`, etc.
@ -458,24 +431,6 @@ To build the entire modpack including supporting files, use the steps in the [Gi
## Prerequisites
- Stable Rust environment with [cargo-skyline](https://github.com/jam1garner/cargo-skyline)
## Development Tips
### Ryujinx
Developing on Ryujinx on Windows is very easy and has a streamlined script in [ryujinx_build.ps1](./ryujinx_build.ps1).
1. Drag-and-drop the normal beta at the Ryujinx paths as described in Installation.
2. Delete the `libtraining_modpack.nro` that is used in those paths.
3. Edit the paths at the top of the file to match your local filesystem
4. On your first run, you may have to run the script as Administrator in order to set up the symlinks to this repo's built files.
- Both the plugin and the [layout.arc](./src/static/layout.arc) will be sourced automatically via symlink
5. Run the script to iterate and develop.
- Logs will be printed to console.
- Since we are using the feature `layout-arc-from-file`, you can edit [layout.arc](./src/static/layout.arc) in real-time with Switch Toolbox and reload training mode without rebooting to view your changes.
- If you'd like to exit, you can CTRL+C the script and Ryujinx will also close.
<a name="beta-changelog"/>
# Beta Changelog

View file

@ -1,57 +0,0 @@
# Change these to match your local
# The first time you run this, in order to set up the symlinks, you may have to be an administrator
# to write the files. Powershell is dumb.
$RYUJINX_LAYOUT_ARC_PATH="C:\Users\Josh\AppData\Roaming\Ryujinx\sdcard\ultimate\TrainingModpack\layout.arc"
$LOCAL_LAYOUT_ARC_PATH="C:\Users\Josh\Documents\Games\UltimateTrainingModpack\src\static\layout.arc"
$RYUJINX_PLUGIN_PATH="C:\Users\Josh\AppData\Roaming\Ryujinx\mods\contents\01006a800016e000\romfs\skyline\plugins\libtraining_modpack.nro"
$LOCAL_PLUGIN_PATH="C:\Users\Josh\Documents\Games\UltimateTrainingModpack\target\aarch64-skyline-switch\release\libtraining_modpack.nro"
$RYUJINX_EXE_PATH="C:\Users\Josh\Documents\Games\Ryujinx\ryujinx-1.1.999-win_x64\publish\Ryujinx.exe"
$SMASH_NSP_PATH='C:\Users\Josh\Documents\Games\ROMs\Super Smash Bros Ultimate [Base Game]\Super Smash Bros Ultimate[01006A800016E000][US][v0].nsp'
$IP=(Test-Connection -ComputerName (hostname) -Count 1 | Select -ExpandProperty IPV4Address).IPAddressToString
# Set symbols flag
$env:RUSTFLAGS="-g"
cargo skyline build --release --features layout_arc_from_file
if (($lastexitcode -ne 0)) {
exit $lastexitcode
}
# Set up symlinks
if(-not(Test-path $RYUJINX_LAYOUT_ARC_PATH -PathType leaf))
{
New-Item -ItemType SymbolicLink -Path $RYUJINX_LAYOUT_ARC_PATH -Target $LOCAL_LAYOUT_ARC_PATH
if (($lastexitcode -ne 0)) {
exit $lastexitcode
}
}
if(-not(Test-path $RYUJINX_PLUGIN_PATH -PathType leaf))
{
New-Item -ItemType SymbolicLink -Path $RYUJINX_PLUGIN_PATH -Target $LOCAL_PLUGIN_PATH
if (($lastexitcode -ne 0)) {
exit $lastexitcode
}
}
try {
# Start the process asynchronously
$process = Start-Process -FilePath $RYUJINX_EXE_PATH -ArgumentList `"$SMASH_NSP_PATH`" -PassThru
# Store the process ID
$global:process = $process.Id
echo "Starting cargo skyline listen..."
cargo skyline listen --ip=$IP
# Makes no sense, but we need this line for logs to show up. Lol
echo "Finishing cargo skyline listen..."
}
finally {
# Interrupts to the script should kill Ryujinx as well
if ($global:process -ne $null) {
Stop-Process -Id $global:process -Force
}
}

View file

@ -1,17 +0,0 @@
set -eu
# Obviously adjust these based on your paths
RYUJINX_APPLICATION_PATH="/mnt/c/Users/Jdsam/Downloads/ryujinx-1.1.119-win_x64/publish/Ryujinx.exe"
SMASH_APPLICATION_PATH="C:\Users\Jdsam\Downloads\Super Smash Bros. Ultimate (World) (En,Ja,Fr,De,Es,It,Nl,Zh-Hant,Zh-Hans,Ko,Ru)\Super Smash Bros. Ultimate (World) (En,Ja,Fr,De,Es,It,Nl,Zh-Hant,Zh-Hans,Ko,Ru).xci"
RYUJINX_SMASH_SKYLINE_PLUGINS_PATH="/mnt/c/Users/Jdsam/AppData/Roaming/Ryujinx/mods/contents/01006a800016e000/romfs/skyline/plugins"
# Build with release feature
RUSTFLAGS=-g cargo skyline build --release --features layout_arc_from_file
# Copy over to plugins path
cp target/aarch64-skyline-switch/release/libtraining_modpack.nro $RYUJINX_SMASH_SKYLINE_PLUGINS_PATH
# Run Ryujinx
$RYUJINX_APPLICATION_PATH "${SMASH_APPLICATION_PATH}"
# Here, you can run `cargo skyline set-ip {IP address...}; cargo skyline listen` for logs