Contributing¶

Here are some ways that you can help contribute to this project.

New ideas or Bug Reports¶

Need something? Found a bug? Or just have a brilliant idea? Head to the Issues and create a new one.

Please feel free to reach out to us on Discord if you're interested in helping out with Geyser.

If you know Java then take a look at open issues and create a pull request.

Do the following to build the code:

git clone https://github.com/GeyserMC/Geyser
cd Geyser
git submodule update --init --recursive
mvn clean install

If you can help improve the documentation it would be highly appreciated. Have a look under the docs folder for the existing documentation.

The documentation is built using mkdocs. You can set up a hot-build dev environment that will auto-refresh changes as they are made.

Install dependencies by running:

pip3 install -r requirements.txt

Note

It's recommended to use a virtualenv so that you don't pollute your system environment.

To start a http document server on http://127.0.0.1:8000 execute:

mkdocs serve

Edit the PDF theme under docs/theme/pdf. Rebuild by doing the following:

cd docs/theme/pdf
npm install
npm run build-compressed

This will update pdf.css under docs/css/pdf.css. Rebuilding the docs will now use the new theme.

Last update: