Skip to content

docs: Update README.md #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 27, 2025
Merged

docs: Update README.md #529

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8161fe1
docs: Update README.md
KANAjetzt Jan 26, 2025
dc7fd06
docs: :memo: more supported godot version info
KANAjetzt Jan 26, 2025
d2ffd1b
docs: :memo: move Discord info below Compatibility
KANAjetzt Jan 26, 2025
56d1863
docs: :memo: added Releases section
KANAjetzt Jan 26, 2025
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
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,14 @@ You can find detailed documentation, for game and mod developers, on the [Uncyclo](
4. Use the [API Methods](https://wiki.godotmodding.com/#/api/mod_loader_api)
*A list of all available API Methods.*

## Godot Version
The current version of the Mod Loader is developed for Godot 3. The Godot 4 version is in progress on the [4.x branch](https://github.com/GodotModding/godot-mod-loader/tree/4.x) and can be used as long as no `class_name`s are in the project. Projects with `class_name`s are currently affected by an [engine bug](https://github.com/godotengine/godot/issues/83542). We are hopeful that this issue will be resolved in the near future. For more details and updates on the Godot 4 version, please follow this [issue](https://github.com/GodotModding/godot-mod-loader/issues/315) or join us on [our Discord](https://discord.godotmodding.com).
## Godot Version
The Mod Loader currently supports Godot 3.5 and later, as well as Godot 4.1 and later. Feel free to [open an issue](https://github.com/GodotModding/godot-mod-loader/issues/new) if you need support for a different version.

## Development
The latest work-in-progress build can be found on the [development branch](https://github.com/GodotModding/godot-mod-loader/tree/development).
## Development
The latest work-in-progress build for Godot 3 is available on the [development branch](https://github.com/GodotModding/godot-mod-loader/tree/development). For Godot 4, visit the [4.x branch](https://github.com/GodotModding/godot-mod-loader/tree/4.x).

## Releases
You can find the latest release versions and detailed installation instructions on the [Releases Page](https://github.com/GodotModding/godot-mod-loader/releases).

## Compatibility
The Mod Loader supports the following platforms:
Expand All @@ -39,6 +42,9 @@ The Mod Loader supports the following platforms:
- Android
- iOS

## Keep in touche
For more details and updates join us on [our Discord](https://discord.godotmodding.com).

## Games Made Moddable by This Project
- [Brotato](https://store.steampowered.com/app/1942280/Brotato/) by
[Blobfish Games](https://store.steampowered.com/developer/blobfishgames)
Expand Down