Skip to content

Commit

Permalink
Fix most of the issues in RSDKModding#160
Browse files Browse the repository at this point in the history
Vulkan information still isn't added, because I don't know how to build it, because there's no information LOL
  • Loading branch information
MegAmi24 committed Mar 2, 2023
1 parent 341d71b commit bc58c26
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions dependencies/android/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
* Ensure the symbolic links in `[root]/android/app/jni` are correct:
* `RSDKv5` -> root of the RSDKv5 repository
* `Game` -> root of the Mania repository (or any other game that you may be compiling)
* Extra symbolic links can be added for things like mods, **as mods do not use the local files for logic.** Just ensure that there is an `Android.mk` file at the root of them.
* Extra symbolic links can be added for things like mods, **as mods do not use the local files for logic.** Just ensure that there are `CMakeLists.txt` files at the root of them.

To add symbolic links, do the following:
* Windows: `mklink /d "[name-of-symlink]" "[path]"`
* Linux: `ln -s "[path]" "[name-of-symlink]"`
* Open `[root]/android/` in Android Studio, install the NDK and everything else that it asks for, and build.

The working directory will be at `[sdcard root]/RSDK/v5`. **Please note that GL shaders are required, or you will get a black screen.** Read the Shaders section in [the GL3 README](../gl3/README.md#shaders) for a guide on how to install them.
The working directory will be at `[sdcard root]/RSDK/v5`. **Please note that GL shaders are required, or you will get a black screen.** Read the Shaders section in [the OGL README](../ogl/README.md#shaders) for a guide on how to install them.


## Common build issues (Windows)
Expand Down
8 changes: 4 additions & 4 deletions dependencies/ogl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
The OpenGL3 backend is mainly used on Linux and Switch, but it does support Windows too.

For Windows, these need to be downloaded and extracted in their respective subdirectories
- **GLEW:** Download from [SourceForge](http://glew.sourceforge.net/), extract it in `dependencies/gl3/glew`
- **GLFW:** Download from [the official site](https://www.glfw.org/download.html), extract it in `dependencies/gl3/glfw`
There are also 32-bit binaries available if you need them, but make sure the RSDKv5 is built for 32-bit too!
- **GLEW:** Download from [SourceForge](http://glew.sourceforge.net/), extract it in `dependencies/ogl/glew`
- **GLFW:** Download from [the official site](https://www.glfw.org/download.html), extract it in `dependencies/ogl/glfw`
There are also 32-bit binaries available if you need them, but make sure the RSDKv5(U) is built for 32-bit too!

For Switch you'll need [devkitPro](https://devkitpro.org/) and GLAD, as GLEW and GLFW are not available. Install GLAD with `sudo dkp-pacman -S switch-glad`

Expand All @@ -20,7 +20,7 @@ For Linux you can install the dependencies using your distro package manager:

To compile you can just use `make`. To customize the build you can set the following options
- `PLATFORM=Switch`: Build for Nintendo Switch.
- `RSDK_REVISION=3`: Compile with support for Origins and S1&2 for mobile. (executable is named RSDKv5U)
- `RSDK_REVISION=2`: Compile regular RSDKv5 instead of RSDKv5U.
- `RSDK_ONLY=1`: Only build the engine (no Game.so)
- `AUTOBUILD=1`: Disable the Plus DLC, which you should do if you plan on distributing the binary.

Expand Down
2 changes: 1 addition & 1 deletion dependencies/windows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* SDL2 (Required for SDL2 backends): https://www.libsdl.org/download-2.0.php
* Download the appropriate development library for your compiler and unzip it in "./SDL2/"

* For the GL3 backends, visit the GL3 README [here.](../gl3/README.md)
* For the OGL backends, visit the OGL README [here.](../ogl/README.md)

## Compiling

Expand Down

0 comments on commit bc58c26

Please sign in to comment.