Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/minekube/gate-plugin-template

A Golang starter template for creating your awesome Minecraft proxy and extensions powered by Minekube Gate 🚀 Fork it!
https://github.com/minekube/gate-plugin-template

gate golang minecraft minecraft-proxy minecraft-reverse-proxy plugin proxy reverse-proxy template

Last synced: about 2 months ago
JSON representation

A Golang starter template for creating your awesome Minecraft proxy and extensions powered by Minekube Gate 🚀 Fork it!

Host: GitHub
URL: https://github.com/minekube/gate-plugin-template
Owner: minekube
License: mit
Created: 2023-12-31T14:49:08.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-07-22T02:37:28.000Z (2 months ago)
Last Synced: 2024-07-22T03:46:38.944Z (2 months ago)
Topics: gate, golang, minecraft, minecraft-proxy, minecraft-reverse-proxy, plugin, proxy, reverse-proxy, template
Language: Go
Homepage: https://gate.minekube.com/developers/
Size: 1.65 MB
Stars: 14
Watchers: 1
Forks: 7
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![License][license-shield]][license-url]






  

    

  

Gate Starter Plugin Template


  


    An awesome template for creating your Minecraft proxy powered by Minekube Gate!

    


    


    Explore the docs »

    


    


    Discord

    ·

    Report Bug

    ·

    Request Feature

  



## About The Project

[![Product Name Screen Shot][product-screenshot]](https://gate.minekube.com)

This template repository bootstraps your [Minekube Gate](https://github.com/minekube/gate) project, a customizable

Minecraft proxy written in Go.

## What's Included?

- `gate.go`: The main entry point of the application.

- `plugins`: The directory for your custom plugins.

- `config.yml`: A minimal Gate configuration file.

- `Dockerfile`: A Dockerfile for building a Docker image.

- `.github/workflows`: GitHub Action for testing, linting, releasing on tags and publishing Docker images to ghcr.io.

- `Makefile`: Contains commands for testing and linting.

- `renovate.json`: Configuration file for Renovate automatic dependency updates.

Prerequisites

## Prerequisites

- [Go](https://golang.org/doc/install) - The Go Programming Language

- [Git](https://git-scm.com/downloads) - Distributed Version Control System

- [GoLand](https://www.jetbrains.com/go/) / [VSCode](https://code.visualstudio.com/) - Gophers' favorite IDEs

## Getting Started

1. Fork this repository on GitHub.

2. Clone forked repository (`git clone `)

3. Open project in your favorite Go IDE.

4. Run the proxy: `go run .`

5. Start customizing Gate to your needs!

## Usage

To create a new Gate plugin, follow these steps:

1. Create and write your plugin code in a new `plugins/xyz/xyz.go` file.

2. Add your exported plugin to the `proxy.Plugins` slice in `gate.go`.

3. Build and run Gate with: `go run .`

Use the `-d` flag to run Gate in debug mode if you encounter issues. (`go run . -d`)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any

contributions you make are **greatly appreciated**.

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feat/AmazingFeature`)

5. Open a Pull Request on GitHub

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/minekube/gate.svg?style=for-the-badge

[contributors-url]: https://github.com/minekube/gate/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/minekube/gate-plugin-template.svg?style=for-the-badge

[forks-url]: https://github.com/minekube/gate-plugin-template/network/members

[stars-shield]: https://img.shields.io/github/stars/minekube/gate.svg?style=for-the-badge

[stars-url]: https://github.com/minekube/gate-plugin-template/stargazers

[issues-shield]: https://img.shields.io/github/issues/minekube/gate.svg?style=for-the-badge

[issues-url]: https://github.com/minekube/gate-plugin-template/issues

[license-shield]: https://img.shields.io/github/license/minekube/gate.svg?style=for-the-badge

[license-url]: https://github.com/minekube/gate/blob/master/LICENSE

[product-screenshot]: https://github.com/minekube/gate/raw/master/.web/docs/public/og-image.png