https://github.com/saltysystems/overworld_client

Godot plugin for Overworld applications
https://github.com/saltysystems/overworld_client

godot godot-engine godot-plugin overworld plugin

Last synced: 3 months ago
JSON representation

Godot plugin for Overworld applications

• Host: GitHub
• URL: https://github.com/saltysystems/overworld_client
• Owner: saltysystems
• License: mit
• Created: 2022-01-30T16:40:11.000Z (about 3 years ago)
• Default Branch: godot-4
• Last Pushed: 2024-08-04T16:36:19.000Z (6 months ago)
• Last Synced: 2024-08-04T18:37:47.032Z (6 months ago)
• Topics: godot, godot-engine, godot-plugin, overworld, plugin
• Language: GDScript
• Homepage:
• Size: 189 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Overworld Client v1.1

## About

This Godot 4.x plugin will allow your Godot applications to download and update the

latest & greatest client bindings from your own [Overworld](https://github.com/saltysystems/overworld) server.

![Plugins](/gh-images/download-compile.png)

## Usage

1. Open your Godot project, or use an existing one.

2. Copy the `addons` directory from this repository to your project

3. Click `Project`, then `Project Settings`.

4. Choose the `Plugins` tab, and set the OverworldClient plugin to `Active`

![Enable](/gh-images/enable-plugin.png)

At this point, the Overworld client panel will appear in Godot. 

You will want to add your server address, e.g. 

```

http://address.of.your.server:/client/download

```

The `/client/download` route is the standard route for autogenerated Overworld

zip files.

Next, you'll want to create or select an output directory. By default, Overworld

assumes that you will put scripts in `res://scripts`. 

Once Overworld compiles your client libraries, it will delete the intermediate

format `.proto` files downloaded from the server. You keep these files if you

wish by selecting `Do not delete .proto files`. However, they are not directly

used by any Overworld client library.