AM2R-Community-Developers
/
AM2RModPacker
mirror of https://github.com/AM2R-Community-Developers/AM2RModPacker
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update readme usage and name references

Browse Source
pull/16/head
Miepee 4 years ago committed by GitHub
parent a744cf2363
commit a67059baf6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File

19
README.md
Unescape View File

@ -1,24 +1,25 @@
# AM2RModPacker # Atomic
Mod packaging toolchain for [AM2RLauncher](https://github.com/AM2R-Community-Developers/AM2RLauncher) mods. 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). 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 and Android mods. It currently supports creating Windows, Linux, Mac and Android mods.
For actual mod creation, it is recommended to use Game Maker: Studio and the [AM2R Community Updates repository](https://github.com/AM2R-Community-Developers/AM2R-Community-Updates), but they can be created with [UndertaleModTool](https://github.com/krzys-h/UndertaleModTool) as well. 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 ## Usage instructions
![grafik](https://user-images.githubusercontent.com/38186597/130315943-4ae7b97d-0ded-4d0d-830f-c779b0ad934a.png) ![screenshot of tool](https://user-images.githubusercontent.com/38186597/209388376-93c07910-89e3-4a4a-a501-d06b094915d4.png)
* Mod name: Specify the name of the mod * Mod name: Specify the name of the mod
* Author: Specify the authors of the mod * Author: Specify the authors of the mod
* Version: Specify the version 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. * Mod notes (optional): Specify notes the users will see about the mod. Consider this like a readme.
* Uses custom save directory: Specify wether or not your mod uses a custom save directory and if yes, which one. Only save locations in `%localappdata` are supported * Uses custom save directory: Specify wether 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 wether or not your mod has custom music in it. * Uses custom music: Specify wether or not your mod has custom music in it.
* Uses the YoYo Compiler: Specify wether 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. If the tool mentions that it was built with YYC, or the file does not exist, it's YYC. * Uses the YoYo Compiler: Specify wether 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 Android: Specify wether or not your mod supports Android, and if yes load in the modded Android APK * Supports Windows: Specify wether or not your mod supports Windows, and if yes load in the modded Windows zip.
* Supports Android: Specify wether or not your mod supports Android, and if yes load in the modded Android APK.
* Supports Linux: Specify wether 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 Linux: Specify wether 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 wether 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. * Load 1.1: Select your valid 1.1 Zip. If you get an error, make sure that the game isn't in any subfolder.
* Load modded game: Select a zip of your modded game for Windows. If you get a warning, make sure that your mod is not placed 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. 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.

Write Preview
Loading…
Cancel
Save