Join the Discord!

GoldenProxy is a proxy server that allows you to modify your connection to a minecraft server, mainly through the use of plugins. It is written in TypeScript and utilises node-minecraft-protocol.

1. Install Node.js (version 18 or higher)
2. Clone the repository (git clone --recurse-submodules https://github.com/GoldenProxy/GoldenProxy.git)
3. Open a terminal in the repository folder and run npm install
4. Copy config.example.json to config.json and edit it to your liking

1. Open a terminal in the repository folder and run npm run dev
2. Join the server you specified in the config (default: localhost:25565 (25565 can be changed with the field connection_port))
3. Check if installed with .gldn plugins

1. Copy the plugin to the plugins folder, if needed, make a folder with the same name specified in the filename of [name].golden.js
2. Restart the server