2f8c69185f API & extension docs & Geyser system property docs (#159)
* initial start on api docs

* oops

* oops #2

* oops #3

* move global api info to global-api.md page, fix typo

* Initial setup page

* the extensions template and list is now in the geysermc org

* add fabric event subscribe example

* fix outdated naming

* the extensions template and list is now in the geysermc org, and therefore official

* spigot/paper plugin geyser-api docs

* minor tweaks

* the setup guide should be in a separate PR, oops

* Updated docs for resource packs PR

* document system properties

* Apply suggestions from code review

Co-authored-by: Redned <redned235@gmail.com>

* move and shuffle pages, address review

* -DGeyser.BedrockNetworkThreads exists too, apparently

* turn notes into banners

* be more specific to indicate this to be advanced stuff

* adjust texts & address camotoy's review

* nms good dont disable

* add chapter on event priorities

* remove whitespace

* main instead of maven-snapshots; floodgate-api 2.2.2

* Move around pages in toc.yml, no need to fully copy event priorities

* Apply suggestions from code review

Co-authored-by: Tim203 <mctim203@gmail.com>

* apply command suggestion

Co-authored-by: Tim203 <mctim203@gmail.com>

* reduce command comments

* specify that this is the Geyser API

* Apply suggestions from code review

Co-authored-by: Redned <redned235@gmail.com>

* dont repeat that the bulk of code would go into a post init event; we already say that

* adress review

* extensions currently target Base API version

---------

Co-authored-by: JensC <jenscollaertyprive@hotmail.com>
Co-authored-by: Redned <redned235@gmail.com>
Co-authored-by: Tim203 <mctim203@gmail.com>
2023-07-09 10:49:13 -05:00
2023-06-14 20:12:21 -05:00
2023-06-07 23:43:34 +01:00
2021-12-13 15:45:43 +00:00
2021-12-12 14:09:40 +00:00
2022-02-26 19:09:05 +00:00

GeyserMC Wiki

This is the repository that contains the wiki for all of GeyserMCs projects.

The wiki can be accessed using this link.

Contributing

If you would like to contribute to the wiki, please open a pull request.

Creating a new page

Most documentation is in the docs folder where you can add new page's or edit the current ones. If a new page is being added make sure you add its page properties at the beginning of the file. Make sure that the file extension is .md in this case pagetitle.md

Example page layout

---
layout: page
title: Page title
permalink: /page/pagetitle/
---

# Page title
This is an example page

Adding page to sidebar

Once you have added the file you can add an sidebar link, All sidebar links + sub links are in the _data/toc.yml file

Example sidebar structure

- title: Page Title Documentation
  url: "page/"
  links:
    - title: "Pagetitle sub link"
      url: "page/pagetitle/"
      children:
        - title: PageChild sub link
          url: "page/pagetitle/#headerLink"
Languages
Markdown 54%
MDX 22.9%
TypeScript 20.5%
SCSS 2.6%