<h1 align="center"> <a href="https://github.com/Alujjdnd/Ngrok-LAN/blob/1.20/IMPORTANT.md">DEPRECATION NOTICE</a> </h1> <h1 align="center"> This project is no longer actively maintained. </h1> Due to a lack of bandwidth in the development team, we've unfortunately had to halt progress on this project, we appreciate your understanding. We recommend alternatives such as e4mc for a similar featureset. Thanks you for your support :) Kind regards, Alujjdnd/Flooflez !(https://github.com/Alujjdnd/Ngrok-LAN/blob/1.18.2/docs/assets/banner.png?raw=true) <h1 align="center"> Ngrok LAN </h1> <div align="center"> <img alt="License" src=https://img.shields.io/github/license/Alujjdnd/Ngrok-LAN> <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/Alujjdnd/Ngrok-LAN"> <img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/Alujjdnd/Ngrok-LAN"> <a href="https://www.codacy.com/gh/Alujjdnd/Ngrok-LAN/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Alujjdnd/Ngrok-LAN&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/b38f7148f2934ad8b6d4413b70a173fd"/></a> <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/alujjdnd/ngrok-lan"> </br> <img src=https://raw.githubusercontent.com/Alujjdnd/Ngrok-LAN/1.18.2/docs/assets/OSSrs.png> </div> ## Help Needed! We are trying to port this mod to QuiltMC, many thanks to those who have contributed already! However, we are hope that a Quilt specific config library will become available to use soon, since our mod requires editing a config file we want the process to be as easy as possible for our users. ## Introduction Ngrok LAN is a Fabric mod that enables you to share your singleplayer world with your friends across the globe, all via clicking on the new "Open Public Server" button! This mod uses Ngrok, a free service to ease the creation of servers, as the main service to "tunnel" your connection to the internet, and will generate a link for your friends to connect to after you click on "Open Public Server". For more on how Ngrok-LAN works, check out (#what-is-ngrok). <div align="center"> <img src="https://raw.githubusercontent.com/Alujjdnd/Ngrok-LAN/1.18.2/docs/assets/demo.gif" alt="Network Diagram" width="70%"/> </div> # Installation/Quick Start ## Dependencies The mod requires the following mods: - (https://fabricmc.net/use/installer/) - (https://www.curseforge.com/minecraft/mc-mods/cloth-config) - (https://www.curseforge.com/minecraft/mc-mods/modmenu) ## Install Fabric Loader and Ngrok-LAN 1. Go to the (https://fabricmc.net/use/installer/) and download the latest installer 2. Run the JAR, a window will pop up. Choose the correct version of Minecraft and loader (this mod currently requires Minecraft v1.18.2 and loader v0.13.3), and click on "Install". 3. A new game version and profile will be created in the launcher's menu, which you can now use to launch Fabric. 4. Put the mod JAR (available under (https://github.com/Alujjdnd/Ngrok-LAN/releases)) into your "mods" folder, along with the ClothConfig API and ModMenu JARs. (The Fabric API JAR should already be in your mods folder from the previous section) 5. Run the newly installed profile from step 3, and Ngrok LAN should load ## Configuring Ngrok-LAN | **Field** | **Description** | |-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| | **"Enabled?"** | This will enable/disable the mod, so you can configure whether the world is shared with Ngrok | | **"Ngrok Auth Token"** | This is the field to input your Ngrok auth token, see (#getting-your-ngrok-auth-token) | | **"Region"** | This is where you can select the region of the Ngrok datacenter that you wish to use, use ones that are closest to you to minimise latency | | **"Require Authentication"**| Ticking this box will start the server in online mode. If this box is unchecked, the server will be started in offline mode. This is mainly for when the other players are using cracked Minecraft accounts. | | **"Spawn Protection Radius"**| Prevents non-opped players from breaking and placing blocks within `X` blocks of spawn | ### Ngrok Regions | Code | Region | |----|---------------| | US | United States | | EU | Europe | | AP | Asia/Pacific | | AU | Australia | | SA | South America | | JP | Japan | | IN | India | ## Starting Ngrok LAN 1. Make sure that Ngrok LAN is enabled, the auth token is valid, and the correct region is selected 2. Open

DEPRECATION NOTICE

This project is no longer actively maintained.

Due to a lack of bandwidth in the development team, we've unfortunately had to halt progress on this project, we appreciate your understanding.

We recommend alternatives such as e4mc for a similar featureset.

Thanks you for your support :)

Kind regards, Alujjdnd/Flooflez

!(https://github.com/Alujjdnd/Ngrok-LAN/blob/1. 18. 2/docs/assets/banner.png?raw=true)

Ngrok LAN

## Help Needed! We are trying to port this mod to QuiltMC, many thanks to those who have contributed already! However, we are hope that a Quilt specific config library will become available to use soon, since our mod requires editing a config file we want the process to be as easy as possible for our users. ## Introduction Ngrok LAN is a Fabric mod that enables you to share your singleplayer world with your friends across the globe, all via clicking on the new "Open Public Server" button! This mod uses Ngrok, a free service to ease the creation of servers, as the main service to "tunnel" your connection to the internet, and will generate a link for your friends to connect to after you click on "Open Public Server".

For more on how Ngrok-LAN works, check out (#what-is-ngrok).

# Installation/Quick Start

## Dependencies

The mod requires the following mods:

• (https://fabricmc.net/use/installer/)
• (https://www.curseforge.com/minecraft/mc-mods/cloth-config)
• (https://www.curseforge.com/minecraft/mc-mods/modmenu)

## Install Fabric Loader and Ngrok-LAN

1. Go to the (https://fabricmc.net/use/installer/) and download the latest installer 2. Run the JAR, a window will pop up. Choose the correct version of Minecraft and loader (this mod currently requires Minecraft v1. 18. 2 and loader v0. 13. 3), and click on "Install". 3. A new game version and profile will be created in the launcher's menu, which you can now use to launch Fabric. 4. Put the mod JAR (available under (https://github.com/Alujjdnd/Ngrok-LAN/releases)) into your "mods" folder, along with the ClothConfig API and ModMenu JARs. (The Fabric API JAR should already be in your mods folder from the previous section) 5. Run the newly installed profile from step 3, and Ngrok LAN should load

## Configuring Ngrok-LAN

| Field | Description | |-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| | "Enabled?" | This will enable/disable the mod, so you can configure whether the world is shared with Ngrok | | "Ngrok Auth Token" | This is the field to input your Ngrok auth token, see (#getting-your-ngrok-auth-token) | | "Region" | This is where you can select the region of the Ngrok datacenter that you wish to use, use ones that are closest to you to minimise latency | | "Require Authentication"| Ticking this box will start the server in online mode. If this box is unchecked, the server will be started in offline mode. This is mainly for when the other players are using cracked Minecraft accounts. | | "Spawn Protection Radius"| Prevents non-opped players from breaking and placing blocks within `X` blocks of spawn |

### Ngrok Regions

| Code | Region | |----|---------------| | US | United States | | EU | Europe | | AP | Asia/Pacific | | AU | Australia | | SA | South America | | JP | Japan | | IN | India |

## Starting Ngrok LAN

1. Make sure that Ngrok LAN is enabled, the auth token is valid, and the correct region is selected 2. Open