You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
26 lines
2.7 KiB
26 lines
2.7 KiB
# Glenn
|
|
Glenn is a tool to make porting builds of self-created AM2R Mods to other platforms easier. This will *only* work with VM-mods of the Community Updates, neither YYC mods nor mods of the original AM2R 1.1 will work.
|
|
You need to have at least .NET Core 6 installed in order to run this.
|
|
|
|
## How do I use this?
|
|
First you need a zip of the self-created mod. If you're using GameMaker: Studio, you can just use the zip it created. If you're using UndertaleModTool you need to zip the files first (your files should not be in a subfolder in the zip!). After that, just feed it into this tool and, select if you want to have a port made for Windows, Linux, Android or Mac.
|
|
It will then create a new zip/apk in the directory next to the program, which can be used for [Atomic](https://github.com/AM2R-Community-Developers/Atomic).
|
|
|
|
To create Android builds, you need to have Java installed.
|
|
|
|
By default, the ports will use stock splash and icon images, however you are able to change those.
|
|
## Porting notes
|
|
- Keep Game Maker: Studio documentation in mind, using any functions that only work on one OS or function differently on different OS could lead to the ports having unexpected behaviour or even crashing.
|
|
- Use `/` for folder seperation, instead of `\`. `\` only works on Windows, `/` works on every OS.
|
|
- Every OS except Android will only write and read from "lowercase" inside of `working_directory`. This means, that if you create a directory called `MyCoolDirectory` and read from it with Game Maker functions, it will actually create the directory `mycooldirectory` instead and read from there. This will only become a problem if you create files/folders *outside* of Game Maker. If you do so make sure that those are all in *lowercase*! As Windows is case-insensitive, it doesn't care for the case of files.
|
|
|
|
### Linux
|
|
- Don't write to the asset folder. Linux is distributed as an AppImage, which makes that whole directory read only and such operations would lead to a crash. Create the files you need in `working_directory` on game boot if they don't exist, and then write to `working_directory` instead. This will create the files and read from them in `~/.config/<mygame>`. Do not ship those files in the asset folder if you're planning to write to them.
|
|
|
|
### Mac
|
|
- The following functions will crash the game if you'll use them:
|
|
- `immersion_play_effect` and `immersion_stop`, `font_replace`. Make sure to either create an OS check before using those, or don't use them entirely. ***AM2R uses these by default, make sure to remove them or create an OS check!***
|
|
|
|
### Android
|
|
- Due to Android being extremely sandboxed, users are unable to get files if you save something to `working_directory`.
|