Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2025 Ryhon
Copyright (c) 2026 Ryhon, AxtelSturnclaw

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# Mod Zip Exporter
Exports the selected folder to a `.zip` for use with mods.
# Vostok Mod Exporter
Exports the selected folder to a `.vmz` for use with mods.
Exports the imported assets and converts text resources to binary resources.
Unlike exporting through the editor with only selected resources and scenes, it doesn't pull in any unnecessary dependencies like the splash screen, autoloads and any resources referenced by your files outside of the selected directory.

<!--
To install, create a `res://addons/mod_exporter` directory, search for ["VostokMods Exporter"](https://godotengine.org/asset-library/asset/3764) in the AssetLib and download it. During installation, press "Change Install Folder" and select the `mod_exporter` folder.
-->

To install, create a `res://addons/mod_exporter` directory, and unzip the latest release into that directory.

Enable the plugin in Project > Project Settings... > Plugins.
A new panel called "Mod" will be created at the bottom of the screen, it will scan for any files named `mod.txt` and add them to the list of mods.
A new panel called "Mod" will be created at the bottom of the screen, it will scan for any folders containing a `mod.txt` file and add them to the list of mods.

Remaps for existing files can be defined by creating a `[remaps]` section in the mod.txt you are exporting. The target path will automatically be resolved to the imported asset path.
Example:
```conf
```ini
[remaps]
"res://MyFile.tres"="res://mods/MyMod/ModdedFile.tres"
```
"res://GameFile.tres"="res://mods/MyMod/ModdedFile.tres"
```
8 changes: 4 additions & 4 deletions plugin.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[plugin]

name="ModExporter"
description="Exprot mods"
author="Ryhon"
version="1.0"
name="Vostok Mod Exporter"
description="Export mods in Vostok Mod Zip (.vmz) format"
author="Ryhon & AxtelSturnclaw"
version="2.0"
script="plugin.gd"
Loading