#docs

1 messages ยท Page 2 of 1

lost sealBOT
lost sealBOT
#

A lot of times people appear in #paper-dev trying to get some packet magic working for basic client side entities, so I figured it would be nice to have some documentation around the already existing API.

The only problem with this is that Entity.setVisibleByDefault and Player.showEntity are still marked as experimental.

lost sealBOT
#
[PaperMC/docs] branch deleted: fix/velocity_title_page
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

The Agolia Crawler currently only allows you to navigate to the page a particular search result is on when it is a node within the Configuration component. This should allow you to navigate correctly by setting the url tag properly.

return helpers.docsearch({
  recordProps: {
    lvl0: {
      selectors: "",
      defaultValue: lvl0,
    },
    url: {
      selectors: "",
      defaultValue: url.toString(),
    },
    lvl1: "h1",
    lvl2: "article h2",
    lvl3: "art...
#
[PaperMC/docs] branch deleted: update_docusaurus_v3
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: userdev-fixup
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/bump-docusaurus
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/bump-docusaurus
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/separate-config-specs
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/center-footer
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feature/command-block-configs
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

Instead of having 1 header with dropdowns for each project and each project's categories, have 1 project dropdown on the left to switch between Paper, Velocity, Folia, and Waterfall. Then the buttons in the header can link to each category of documentation, Administration, Development, Contributing.

Then the sidebars for each of those categories can be simplified to only show docs in those categories instead of showing all the docs for paper, or all of velocity which it currently does.

...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/separate-config-specs
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/add-startup-script-creation
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/update-docusaurus
#

There should probably also be some error handling in the file name box so you don't end up nothing there?

Maybe just keep server.jar as a placeholder for the field and if they don't enter it use that as the default, perhaps?

The server.jar is the default value in the State, which results in it being inside the box and not just a placeholder. I will add validation though and default to server.jar

lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/update-docusaurus
#
[PaperMC/docs] branch deleted: feature/command-block-configs
lost sealBOT
#
[PaperMC/docs] New branch created: feat/add-api-examples
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/document-bukkit-worldgen
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: fix/vercel-attribution
lost sealBOT
#
[PaperMC/docs] branch deleted: fix/vercel-attribution
#
[PaperMC/docs] branch deleted: feat/add-startup-script-creation
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/restructure-paper-docs
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/add-api-examples
#
[PaperMC/docs] branch deleted: feat/add-link-cards
lost sealBOT
#
[PaperMC/docs] New branch created: feat/document-mob-goals
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/adventure-audiences
lost sealBOT
#
[PaperMC/docs] New branch created: feat/chat-event
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/doc-sand-duping
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/restructure-paper-docs
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/adventure-audiences
lost sealBOT
#
[PaperMC/docs] New branch created: feat/property-api
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/warn-unsupported-settings
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/warn-unsupported-settings
lost sealBOT
#
[PaperMC/docs] New branch created: feat/update-docusaurus
#
[PaperMC/docs] New branch created: feat/update-docusaurus-3.1.1
#
[PaperMC/docs] branch deleted: feat/update-docusaurus
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: fix/proper-aikars-flags-for-higher-memory
lost sealBOT
#

I personally would've gone with this change for the Permission section to make it clear that a plugin is responsible for defining child-/sub-permissions to be part of a main one (Also adds note about the wildcard (*) permission and its use in permission plugins):

Permissions are a way to control who can run commands and who can listen to events. Permissions 
are registered by plugins and can be checked by other plugins. Permissions can be granted to players and groups. 
Perm...
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: cleanup-aikars-flags
#
[PaperMC/docs] branch deleted: fix/proper-aikars-flags-for-higher-memory
lost sealBOT
#
[PaperMC/docs] branch deleted: cleanup-aikars-flags
lost sealBOT
#

Material javadoc isn't really user friendly, including the fact that it still has legacy materials which confuses new people

This would be a good addition to https://docs.papermc.io/paper/cat/admin/reference

The general idea is to make an alternative solution which is more user friendly than something made as a code documentation

My idea on how this could be done is a table

  • The table has a mode at the top where the user can select between "all materials", "items" and "blocks". The select...
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/update-docusaurus-3.1.1
lost sealBOT
#
[PaperMC/docs] New branch created: feat/basic-grammar-checker
lost sealBOT
#

Somehow the favicon is not visible/not found from Firefox. The network analyze tool indicates a wrong search location for the favicon.ico: https://docs.papermc.io/img/favicon.ico - the favicon.ico can be found in https://docs.papermc.io/favicon.ico.

This bug is not reproducable on Chrome and Chrome based browsers because they use the icon-144x144.png (or smaller pngs) in the img directory.

lost sealBOT
#
[PaperMC/docs] branch deleted: feat/basic-grammar-checker
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/property-api
lost sealBOT
#

in the script showed here it asks for a project entry but uses it only once and does not implement it in the way that it could support all projects.

this is the script listed on the docs:

#!/bin/bash

PROJECT="paper"
MINECRAFT_VERSION="1.20.4"

LATEST_VERSION=$(curl -s https://api.papermc.io/v2/projects/paper | \
    jq -r '.versions[-1]')

LATEST_BUILD=$(curl -s https://api.papermc.io/v2/projec...
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: ench/translation-hint
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/sunsetting
lost sealBOT
lost sealBOT
lost sealBOT
#

do we really need to copy in the whole theme when we (at least from a quick glance) only modify one file?

Unfortunately when you eject it includes all those components. I tried deleting some and had some issues however I believe that may have been caused by something else I have now fixed, so Iโ€™ll have a lool

lost sealBOT
lost sealBOT
lost sealBOT
#

Btw, well aware this is one of those ๐Ÿค“ reviews, just one to try and get credit (Similar to Beg Bounties), however with how large the project is and how many eyes are put on it each month, maintaining professional and correct customer-facing info is important. I genuinely couldn't care less if this is fixed or not, just thought I'd point it out. Regardless, I'm glad to see Waterfall being sunset, Velocity really is vastly superior and I'm glad th...

lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/doc-sand-duping
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

Crossref for https://github.com/PaperMC/Paper/pull/10312

We should have a page which serves to get new server owners into some level of swing, this will mostly be a point of leading server owners to more dedicated guides in a friendly manner, but, may also decide to contain some general recommendations, i.e. how to whitelist, for example.

Not 100% sure what a good onboarding page would contain, however, that is probably a discussion point here

lost sealBOT
#
[PaperMC/docs] New branch created: feat/admin-landing-page
#

This could be a decent idea as long as the page is kept simple and easy to follow and serve as a starting point for someone completely new.

Contribution is always welcomed; however, it is always good to communicate via Discord with our maintainers before proceeding to avoid doing extra work.

  • How to use whitelist features
  • How to use basic command such as OP and gamerules with reference to official Minecraft wiki.
  • How to add and update plugins
  • How to update Paper version...
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/admin-landing-page
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
#

see also #21 (basically the same thing, but dead for 2 years).


I might be too cynical but I do not believe a page like this can be conclusive and should have a warning on the top saying that if you are after complete vanilla behaviour, you should use fabric or vanilla. Without that I see it causing additional frustration for people who want a completely vanilla experience. It could still be very useful for people who don't need that, though.

#

Yeah, to get the closest Vanilla experience, it should just be a recommendation to use Fabric. In case people wish to use plugins or enjoy the optimization from Paper, the idea of having a preset feature would be kind of nice.

I can say that the demand for a Vanilla-like Paper server is there, as one of my blog posts has one of the most hits via Google search, so having something official would indeed be nice. For example, Spigot has very low player tracking range (48 blocks) and is one of...

lost sealBOT
#

This PR aims to set the foundation for the "How to get as close as possible to a vanilla experience" page.
I took https://github.com/PaperMC/docs/issues/21#issuecomment-1062254884 as a reference for the initial work. Some of the settings listed don't exist anymore.

I am sure those are not the only ones. Therefore, I would appreciate it if we can find more settings together as it would be a huge effort for one person to go through every setting.

Ideally, we would add a little text to...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/sunsetting
lost sealBOT
#

Lots of projects in this space have stalled since the Forge/Neo split, but the current release works fine. There's quite a few people in the Ambassador Discord that use BungeeForge to support legacy forwarding on newer MC versions, myself included (I would rather use modern forwarding, but I support some older servers in the same network). I've also used it for a couple of old 1.12.2 modpacks and an old 1.7.10 modpack that I wanted to hook up to my network that didn't mesh well with SpongeFor...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: fix/deprecation-links
lost sealBOT
#
[PaperMC/docs] branch deleted: fix/deprecation-links
lost sealBOT
lost sealBOT
#

This PR removes nearly all instances of inline styling leaving only three untouched. Ternary operator calls in className have been replaced with the clsx() helper method for improved readability.

  1. A // TODO: dynamic class comment has been added next to the leftover complex inline styles.
  2. Inline styles calling the margin[...] properties have been updated to use Docusaurus' margin-[...]--sm and margin-[...]--md classes for consistent margin sizes.
  3. Inline styles have been merged...
lost sealBOT
lost sealBOT
#

Hi! Thank you for opening this PR, however this was not the intention we had behind this example. As @zlataovce said, this is technically correct as-is, however this latest version query should be a different example. If you would like to work on this, please open another PR! ๐Ÿ˜„

He didn't say that this is correct as-is, because it's not, however i think he is right and there should be two different examples, i may work on this when i have time.

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

adds an @echo off in front of all windows scripts and adds a pause statement after if auto restart is disabled. This is because people on windows tend to double click the start.bat instead of opening a terminal and running the script from there, which causes the terminal to close when the server stops without giving the user the option to look at e.g. crash logs, i have noticed a lot of people on the discord server just saying "my server stops without any crash log" because of this exact reason.

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/document-tripwire-changes
#
[PaperMC/docs] New branch created: feat/docusaurus-3.2.0
#
[PaperMC/docs] branch deleted: feat/document-tripwire-changes
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

The -Djava.net.preferIPv6Addresses=true flag must be present on IPv6 only machines when first starting a paper server or otherwise it will fail to download the vanilla server file.

This is a good hint for all newbies, which should be present in the paper Getting Started docs.

I can add some IPv6 docs myself as I'm setting up velocity and paper on an IPv6 only machine at the moment.
If someone can tell me where to put them, I would be happy to help ;)

lost sealBOT
#

This is an attempt at standardizing some syntax and cleaning up capitalization + punctuation.

Top-level headings (#) should all now be Upper Cased Like This, while other ones (##, ###, ...) Have only the first letter capitalized.

Class, file, config key, ... references are now encased in backticks.

Some British English words were switched to their American counterparts and added to the spell checker.

#
[PaperMC/docs] New branch created: feat/quick-rearranging-of-components
#
[PaperMC/docs] branch deleted: feat/quick-rearranging-of-components
#
[PaperMC/docs] New branch created: feat/update-docusaurus
lost sealBOT
#
[PaperMC/docs] New branch created: feat/seperate-navbars
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feat/update-docusaurus
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

a simple check would not work - each time the config is called it ends up re-running the method. (incrementing a variable every time it ran would always output 1).

The config gets called and loaded 3 times separately - at the very beginning of the build, right before the parseFrontMatter method is called, and sometime near the very end of the build.

The best solution I can think of is checking a variable used by docusaurus that's in scope when the method is called.

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[ERROR] FileNotTrackedError: Failed to retrieve the git history for file "docs/misc/tools/minimessage-web-editor.md" because the file is not tracked by git.
    at matchFromRegex (F:\Projects\paperdocs\node_modules\.pnpm\@docusaurus+utils@3.2.1_patch_hash=yygnmtjhmebpawcus5yp7z64bi_@docusaurus+types@3.2.1_esbuild@0.20.2\node_modules\@docusaurus\utils\src\gitUtils.ts:181:11)
    at getFileCommitHash (F:\Projects\paperdocs\node_modules\.pnpm\@docusaurus+utils@3.2.1_patch_hash=yygnmtjhmeb...
lost sealBOT
#
[PaperMC/docs] New branch created: tools
lost sealBOT
#

This makes the content more immediately accessible and easier to browse through. Styling has also been adjusted as necessary to accomodate a flatter hierarchy of items; presenting content as a list with headers instead of a grid of cards.

ATM, the hierarchy of other stuff isn't flattened; I can do that if y'all like how it looks on the Paper dev pages.

before
after

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: update-java-toolchain-version
#
[PaperMC/docs] branch deleted: update-java-toolchain-version
lost sealBOT
#

I have also tried updating the paperweight docs but i just don't understand it. To my understanding I would have to add paperweight.reobfArtifactConfiguration = io.papermc.paperweight.userdev.ReobfArtifactConfiguration.MOJANG_PRODUCTION to my build script if I want my plugin to be moj mapped but

  1. It is moj mapped anyway and
  2. If i add this line, it prints me an error that it could not resolve the MOJANG_PRODUCTION property
  3. It doesn't make sense to add this as userdev would set i...
lost sealBOT
lost sealBOT
lost sealBOT