https://github.com/gaming32/world-host

Host your singleplayer worlds without having to run a server or setup port forwarding! In the future, we also plan to support Bedrock Edition clients through the use of Geyser.
https://github.com/gaming32/world-host

Last synced: about 1 month ago
JSON representation

Host your singleplayer worlds without having to run a server or setup port forwarding! In the future, we also plan to support Bedrock Edition clients through the use of Geyser.

• Host: GitHub
• URL: https://github.com/gaming32/world-host
• Owner: Gaming32
• License: mit
• Created: 2023-02-28T15:51:47.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-04-05T17:44:54.000Z (about 2 months ago)
• Last Synced: 2025-04-10T23:42:20.219Z (about 1 month ago)
• Language: Java
• Size: 1.36 MB
• Stars: 67
• Watchers: 5
• Forks: 12
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • Changelog: changelogs/0.3.0.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# World Host

[![Modrinth](https://img.shields.io/modrinth/dt/world-host?color=00AF5C&label=Downloads&style=round&logo=modrinth)](https://modrinth.com/mod/world-host)

![Mod Environment](https://img.shields.io/badge/Enviroment-Client-purple?style=round)

[![Server uptime](https://img.shields.io/uptimerobot/ratio/m794216582-8c2e3383b556b643f86c85fe?label=Server%20uptime&color=blue)](https://stats.uptimerobot.com/jL0OztYWBj)

Host your singleplayer worlds **without having to run a server or setup port forwarding!** In the future, we also plan to support Bedrock Edition clients

through the use of Geyser.

## What if my friend doesn't have the mod installed?

If your friend doesn't have the mod installed, you cannot use the friends system with them. However, you can run the command `/worldhost ip` to get an IP that can be used with tunneling. Do note, however, that not using the friends system could increase ping. If you don't want the ping increase, you can run `/worldhost tempip` to get a *temporary* server IP that lasts for at least 60 seconds. Clients who connect within the 60 seconds will remain connected. If you plan to never use the friends system, you can disable it in the mod settings.

## How does this mod work?

This mod has a server that your client connects to, this server is used to communicate with other clients using World Host. 

1. When your friend wants to join you, your friend's client asks the server for an IP address to connect to. 

2. The server then asks your client to create a join mode (`JoinType` in the protocol). There are two join mods: UPnP and Proxy. 

3. UPnP mode is tried first. Your client tries to open a temporary port forward in your router that your friends client can use to connect to you directly. 

4. If UPnP succeeds, your client tells the server the port to use, then the server tells your friend's client your IP and the port number. 

5. If UPnP fails, then your client tells the server to use Proxy mode. The server will then give your friend's client the same "proxy IP" as `/worldhost ip` does. 

 

`/worldhost tempip` tries to do UPnP first instead of just giving you the proxy IP straightaway.

## License

The mod is open source and licensed under the [MIT License](LICENSE).