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.
AM2RModPacker/README.md

26 lines
2.6 KiB

# Atomic
Atomic (AM2R Tool: Organized Modpacker in C#) is a mod packaging toolchain for [AM2RLauncher](https://github.com/AM2R-Community-Developers/AM2RLauncher) mods.
This is for modcreators who wish to make their mods usable with the [AM2RLauncher](https://github.com/AM2R-Community-Developers/AM2RLauncher).
It currently supports creating Windows, Linux, Mac and Android mods.
For actual mod creation, it is recommended to use [UndertaleModTool](https://github.com/krzys-h/UndertaleModTool), but they can be created with Game Maker: Studio and the [AM2R Community Updates repository](https://github.com/AM2R-Community-Developers/AM2R-Community-Updates) as well.
## Usage instructions
![screenshot of tool](https://user-images.githubusercontent.com/38186597/209388376-93c07910-89e3-4a4a-a501-d06b094915d4.png)
* Mod name: Specify the name of the mod
* Author: Specify the authors of the mod
* Version: Specify the version of the mod
* Mod notes (optional): Specify notes the users will see about the mod. Consider this like a readme.
* Uses custom save directory: Specify whether or not your mod uses a custom save directory and if yes, which one. Only save locations in `%localappdata%` (and the equivalent on other OS) are supported
* Uses custom music: Specify whether or not your mod has custom music in it.
* Uses the YoYo Compiler: Specify whether or not your mod was built with the YoYo Compiler or not. A quick way to find out, is try opening the `data.win` file in the above mentioned [UndertaleModTool](https://github.com/krzys-h/UndertaleModTool). If the tool mentions that it was built with YYC, or the file does not exist, it's YYC.
* Supports Windows: Specify whether or not your mod supports Windows, and if yes load in the modded Windows zip.
* Supports Android: Specify whether or not your mod supports Android, and if yes load in the modded Android APK.
* Supports Linux: Specify whether or not your mod supports Linux, and if yes load in the modded Linux zip. For GameMaker: Studio users, you can just use the one that gets created. For non GM:S users, please make sure that the executable is either named `AM2R` or `runner` and that neither the `assets` folder nor the executable is in a subfolder.
* Supports Mac: Specify whether or not your mod supports Windows, and if yes load in the modded Mac zip.
* Load 1.1: Select your valid 1.1 Zip. If you get an error, make sure that the game isn't in any subfolder.
After filling everything out appropriately, just click on the `Create Mod package(s)` button, which will ask you where to save your AM2RLauncher-compatible mod and then create them.