#docs

1 messages · Page 3 of 1

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: entity-argument
lost sealBOT
#
[PaperMC/docs] New branch created: convert-functions
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/brigadier-api
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feature/bump-userdev-version
#
[PaperMC/docs] branch deleted: feature/bump-userdev-version
lost sealBOT
#

A common trap that people fall into with a binary search is removing dependencies of other plugins, either data or functionality wise, it would probably be an idea to make a note of this sort of caveat;

Common examples would be Libraries like Vault (and providers for vault, i.e. perm plugins, eco, etc)/ProtocolLib, not having these installs would generally disable plugins or subsets of their functionality which could be problematic, causing these libraries to become the "blame", even if t...

lost sealBOT
#

I don't think the huge empty spaces should be there

java -Xms10G -Xmx10G -XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:MaxGCPauseMillis=200 -XX:+UnlockExperimentalVMOptions -XX:+DisableExplicitGC -XX:+AlwaysPreTouch -XX:G1NewSizePercent=30 -XX:G1MaxNewSizePercent=40 -XX:G1HeapRegionSize=8M -XX:G1ReservePercent=20 -XX:G1HeapWastePercent=5 -XX:G1MixedGCCountTarget=4 -XX:InitiatingHeapOccupancyPercent=15 -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=5 -XX...
lost sealBOT
lost sealBOT
#

meh, idk, on second thought (and after looking around), I think having our own docs for everything commands is the better option. can/should be added later tho, this is a good enough starting ground.

existing briagdier docs can be found at fabric (its really mod specific, https://fabricmc.net/wiki/tutorial:commands) and in the readme (its really basic and not minecraft specific https://github.com/Mojang/brigadier#registering-a-new-command)

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

The Recipe system is generally a weird area of undocumented cruft and limitations, there currently exists no real documentation anywhere for how to use this system, which is especially a bit of a crux given the limitations of the system (i.e. dealing with custom items, counts, etc)

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

tried running teleportAsync in ForkJoinPool#commonPool and joined the future, worked just fine

teleport failed as expected:

[19:10:15 WARN]: Exception in thread "ForkJoinPool.commonPool-worker-1" java.lang.IllegalStateException: PlayerTeleportEvent may only be triggered synchronously.
[19:10:15 WARN]: 	at io.papermc.paper.plugin.manager.PaperEventManager.callEvent(PaperEventManager.java:42)
[19:10:15 WARN]: 	at io.papermc.paper.plugin.manager.PaperPluginManagerImpl.callEvent(...
lost sealBOT
lost sealBOT
#
:::note[Performance]

We recommend using `teleportAsync` when you expect to be teleporting into unloaded chunks. Teleporting 
synchronously *will* have an impact on server performance when called from the main thread, however using
`teleportAsync` does come with the caveat of all subsequent code being called from within the `onAccept`, 1 tick later.

For simple teleports within nearby (loaded) chunks, the performance different is small enough to justify using either.

:...
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: fix/mention-library-plugins
lost sealBOT
#
[PaperMC/docs] New branch created: chore/update-pnpm
#
[PaperMC/docs] branch deleted: chore/update-pnpm
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

Looking at it again. Are we really sure to not follow semver here on purpose? The current docs say that the api version has no minor version, although it should be the patch.

I would suggest to actually phrase it like this, which applies more to the correct naming scheme.

The version of the Paper API that your plugin is using. This doesn't include the patch version (e.g. 1.13) until 1.20.5. From 1.20.5 and onward, a patch version (e.g 1.20.5) is supported.
lost sealBOT
lost sealBOT
lost sealBOT
#
Whilst many people may not notice the inconsistencies, there are situations where they become problematic. One example is that technical players may struggle getting their machines to work like they should
This page aims to provide a starting point for players who want to get as close to Vanilla as possible.

:::info

This page is inspired by [Earthcomputer's collection](https://gist.github.com/Earthcomputer/2296da33b8cc91dba81b48103c0e1fe3) of Vanilla breaking changes.

...
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feature/registries
#

Deploying papermc-docs with  <a href="https://pages.dev"><img alt="Cloudflare Pages" src="https://user-images.githubusercontent.com/23264/106598434-9e719e00-654f-11eb-9e59-6167043cfa01.png" width="16"></a>  Cloudflare Pages

<table><tr><td><strong>Latest commit:</strong> </td><td>
<code>12c76e9</code>
</td></tr>
<tr><td><strong>Status:</strong></td><td>🚫  Build failed.</td></tr>
</table>

[View logs](https://dash.cloudflare.com/?to=/:account/pages/view/papermc-docs/92979c33-...

#
    `net.kyori.adventure.key.Key` represents a namespace and a key.
  </li>
  <li>
    <Javadoc name={"io.papermc.paper.registry.TypedKey"}>TypedKey</Javadoc> wraps an adventure key,
    but also includes the <Javadoc name={"io.papermc.paper.registry.TypedKey#registryKey()"}>key of
    the registry</Javadoc> the

singular sounds better here

#

Deploying papermc-docs with  <a href="https://pages.dev"><img alt="Cloudflare Pages" src="https://user-images.githubusercontent.com/23264/106598434-9e719e00-654f-11eb-9e59-6167043cfa01.png" width="16"></a>  Cloudflare Pages

<table><tr><td><strong>Latest commit:</strong> </td><td>
<code>bd9f5c3</code>
</td></tr>
<tr><td><strong>Status:</strong></td><td> ✅  Deploy successful!</td></tr>
<tr><td><strong>Preview URL:</strong></td><td>
<a href='https://485cdd4c.papermc-docs....

#

Deploying papermc-docs with  <a href="https://pages.dev"><img alt="Cloudflare Pages" src="https://user-images.githubusercontent.com/23264/106598434-9e719e00-654f-11eb-9e59-6167043cfa01.png" width="16"></a>  Cloudflare Pages

<table><tr><td><strong>Latest commit:</strong> </td><td>
<code>fbe674f</code>
</td></tr>
<tr><td><strong>Status:</strong></td><td> ✅  Deploy successful!</td></tr>
<tr><td><strong>Preview URL:</strong></td><td>
<a href='https://a5cf0d77.papermc-docs....

#
[PaperMC/docs] branch deleted: feature/registries
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/add-trial-chambers-seed
#

Deploying papermc-docs with  <a href="https://pages.dev"><img alt="Cloudflare Pages" src="https://user-images.githubusercontent.com/23264/106598434-9e719e00-654f-11eb-9e59-6167043cfa01.png" width="16"></a>  Cloudflare Pages

<table><tr><td><strong>Latest commit:</strong> </td><td>
<code>1d11389</code>
</td></tr>
<tr><td><strong>Status:</strong></td><td> ✅  Deploy successful!</td></tr>
<tr><td><strong>Preview URL:</strong></td><td>
<a href='https://fa9b567f.papermc-docs....

lost sealBOT
#

Fixes broken metadata and makes the sitemap generate once again. To me, it seems like there's no way to get a deployment URL at build time, so this PR tries to guess it for previews.

Based on my observations, deployment URLs are formatted in the https://.papermc-docs.pages.dev format, where `` is a - identifier capped to 28 characters and special characters (/, _, .) replaced with a dash.
Examples:

  • https://papermc-feat-add-trial-chamb.papermc-docs.pages.dev
  • `https://zl...
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

Eh, I don't see a particular value in this

Yeah but as I tried using this doc specifically myself I realized that it is pretty much useless when it comes to implementing more complex commands and arguments so I added a note that links to the example plugin so that people wanting to use the new API have a reference on how to do things. I'm also currently working on expanding the docs so it would just be a note for a few days :)

#

I think we are fine without a note :+1: Given the entire thing is experimental anyway, it should be kind of a given things are incomplete. Merging a commit just to revert it later also seems kinda bleh, the brigadier command API is additionally also not something we expect to be 100% easily usable. That is what BasicCommand exists for.

If you want to work on the commands docs, that would be awesome! But yea, I don't see value in adding a note.

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
From ac45756ede7ee7d5b5a5ac737a8eb1a7c8c82ec9 Mon Sep 17 00:00:00 2001
From: Ollie <69084614+olijeffers0n@users.noreply.github.com>
Date: Mon, 1 Jul 2024 14:57:56 +0100
Subject: [PATCH] Fix CSS on new node

---
 .../config/ConfigurationStructureDiagram.tsx        |  6 +++++-
 src/css/configuration-explorer-layout.css           | 13 +++++++++++++
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/src/components/config/ConfigurationStructureDiagram.tsx b/src/componen...
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
  • [ ] explain that timings is gone (and why)
  • [ ] explain what spark is
  • [ ] link to spark docs for usage
  • [ ] explain paper.startSparkBackgroundProfilerImmediately (and add it to the system property page too, can link back to spark page)
  • [ ] explain how to change the spark version
  • [ ] add spark config/folder to the folder view
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
We implemented the <Javadoc name={"io.papermc.paper.command.brigadier.argument.CustomArgumentType$Converted"}>CustomArgumentType.Converted</Javadoc>
interface. This interface takes two type arguments: our custom enum, T, and a native Java type called N.

- `convert()` converts the native type (in this case `String`) into our custom type.

-  `getNativeType()` returns the type of string that our command argument uses. This uses a single word, so we return `StringArgumentTyp...
lost sealBOT
#
[PaperMC/docs] New branch created: document-sprint-interruption-bug
#

Deploying papermc-docs with  <a href="https://pages.dev"><img alt="Cloudflare Pages" src="https://user-images.githubusercontent.com/23264/106598434-9e719e00-654f-11eb-9e59-6167043cfa01.png" width="16"></a>  Cloudflare Pages

<table><tr><td><strong>Latest commit:</strong> </td><td>
<code>5b1c26d</code>
</td></tr>
<tr><td><strong>Status:</strong></td><td> ✅  Deploy successful!</td></tr>
<tr><td><strong>Preview URL:</strong></td><td>
<a href='https://0bc0fe6f.papermc-docs....

#
[PaperMC/docs] New branch created: feat/document-max-tick-amounts
#

Deploying papermc-docs with  <a href="https://pages.dev"><img alt="Cloudflare Pages" src="https://user-images.githubusercontent.com/23264/106598434-9e719e00-654f-11eb-9e59-6167043cfa01.png" width="16"></a>  Cloudflare Pages

<table><tr><td><strong>Latest commit:</strong> </td><td>
<code>d6a3413</code>
</td></tr>
<tr><td><strong>Status:</strong></td><td> ✅  Deploy successful!</td></tr>
<tr><td><strong>Preview URL:</strong></td><td>
<a href='https://faf65478.papermc-docs....

#
[PaperMC/docs] branch deleted: feat/document-max-tick-amounts
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

The Issue

Hey! I'm the maintainer of the Github Action refined-cf-pages-action and we were recently made aware of a security vulnerability regarding the pull_request_target workflow event where it's possible to leak secrets (including the CF credentials used in the action) through a Github Actions exploit when running untrusted code. Unfortunately, our previous recommendation for the setup of the PR Previews from Forks featu...

lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: deps/docusaurus
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

I do not like the current solution to the "how-to vanilla" page. Thats why I am proposing a refactor that merges the two files with adding a vanilla field to config options that alter the vanilla behavior.

only-merge-items-horizontally:
  vanilla: "true"
  default: "false"
  description: >-
    Prevents merging items that are not on the same y level, preventing potential
    visual artifacts.

I am aware of the unnecessary nodes showing no default value. Unfortunatel...

lost sealBOT
#

Given we don't really provide groovy support anywhere else in the docs (as we heavily favour kotlin) I'd be in favour of making this a bit less verbose.

Something like a general note at the bottom saying that "The static members above are accessed with a get prefix when using the groovy dsl"
Or something along those lines. Generally, just wanna make sure it doesn't look like we actually encourage using groovy.

lost sealBOT
#

PaperMC/Paper#10440
ideas on how to nicely implement documentation for this type of dynamic config section are appreciated as the way i did it is certainly not perfect. Feel free to ping me on discord if you have ideas as i might not check this as often and allows for easier conversations.

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

Currently, if you go to the docs via the normal paper page and then to the developer section, you cannot find the JavaDocs directly. It would be good, based on the experience of other documentations, that there should be a direct link to docs in the general overview.

I know that there is a link in the footer but it can happen, as it happened to me, that the link is overlooked.

Here is an example graphic:

![Screenshot_20240817_210947](https://github.com/user-attachments/assets/2476a0...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: fix/worker-threads
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/despawn-range-shape
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

A quality of life improvement for developers, adding a note that specifies data is not automatically copied over for you would help with confusion.

Following the components update, components from the ItemMeta (including PublicBukkitValues) are copied over. This however, can be deceiving, as with commands such as /data it appears the data is carried across to a TileState, when it is not.
image

Thi...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

The table alone after a heading looks weird. I think some sort of introduction to why some operations are not supported would be nice to have.

Due to and Velocity currently only supports the following audience operations:

You mean a general introduction before the table, right, and not a description for each operation?

Yes just a message before the table explaining why there are certain methods not implemented.

lost sealBOT
#
[PaperMC/docs] branch deleted: feat/add-trial-chambers-seed
lost sealBOT
lost sealBOT
lost sealBOT