^ I'd say the same with the Miscellaneous landing page.
#docs
1 messages ยท Page 2 of 1
Velocity does this already within the Admin/Dev. Added Misc and also realised i named the branch velocity instead of waterfall ๐คฆ
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.
3946edc Rework title pages to use mdx for doc cards (#266) - olijeffers0n
[PaperMC/docs] branch deleted: fix/velocity_title_page
Thanks for your addition. The naming is slightly misleading because these are server-side entities, not client-side. There is also a lot of room for improvement on the implementation side. Maybe if you note that this is a fairly quick and dirty way of doing this it would be better
The Internationalization page should probably also be added to Velocity
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...
2c4ed22 Change dots to @site/docs - olijeffers0n
[PaperMC/docs] branch deleted: update_docusaurus_v3
So can't you use the cheerio instance to get the href for the a tag? then make that the url.
<img width="821" alt="image" src="https://github.com/PaperMC/docs/assets/15055071/18e31c02-ece3-4e93-b774-5cb131e9fe84">
[PaperMC/docs] New branch created: userdev-fixup
Bumped the pw version, fixed a couple typos/grammar issues, and made mentions of paperweight-userdev more consistently stylized, notable exception is I left the sidebar Title Case since it felt weird with the usual kebab case used by pw.
662b0ff Minor improvements to internals and userdev pag... - jpenilla
[PaperMC/docs] branch deleted: userdev-fixup
f0e1304 Bigger Disclaimer on sending plugin messages to... - olijeffers0n
fd0dd9b Bump Docusaurus to 3.0.1 - olijeffers0n
[PaperMC/docs] New branch created: feat/bump-docusaurus
Doesn't contain bug fixes that directly affect us, but best to keep up to date
Need to update the patch (really just change filename, doesn't need any real changes) for @docusaurus/plugin-content-docs.
You can see right now that versioning doesn't work due to that not being present.
Blocking on PaperMC/Paper#9971 being merged, and a docs page being added for this to link to.
@Machine-Maker should I add that page in this pr as well?
I'd hold off, at least until someone else voices support for the format of that file. Don't want you doing a whole page only for it to all change later.
Sorry, what line specificly? I'm guessing the one that mentions the other pr, but want to check before I get back to my computer
Yeah about seeing a file that doesnโt exist, removing line 24 that is. Donโt worry about doing it in a hurry (idk what timezone you are) I wonโt likely merge it until some point tomorrow
157611d separate server.properties spec into another file - Machine-Maker
[PaperMC/docs] New branch created: feat/separate-config-specs
I think its best if the specs for the various configs are loaded from a separate file instead of inline. Gives benefits when editing the yml directly in editors and prepares for a time from when the specs are read from the web instead of hardcoded.
Looks like a good start, the only thing I was wondering was if we wanted to maybe place the YML files within a subdirectory like we do with assets? Other than that this should be good
Looking at this, i'm not a fan of how this works.
[PaperMC/docs] branch deleted: feat/seperate_topics
[PaperMC/docs] New branch created: feat/center-footer
d36cfc2 Add link cards to topics - olijeffers0n
[PaperMC/docs] New branch created: feat/add-link-cards
prepares for a time from when the specs are read from the web
maybe we should define them as a json schema then?
Looks like a good start, the only thing I was wondering was if we wanted to maybe place the YML files within a subdirectory like we do with assets?
Yeah, we could do that. Probably doesn't have to be in the docs/ directory
Is there anything making this not ready for review?
I would also update the description of the example below. It's correct, but says the inversed perspective of what you define
Not quite sure what you mean here, could you elaborate please?
Config Descriptions are now versioned. This should be everything feature wise!
My thought process here was that you could just return the <a> tag regardless and the href would just load in the background. maybe one with an empty href so that you don't end up with a duff link whilst it loads?
d3bdac7 Add description for command block config values - Machine-Maker
[PaperMC/docs] New branch created: feature/command-block-configs
LGTM - Obviously blocked by Paper though
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.
...
and signed-by is best practice
9c17cd5 Separate config specs into other files (#272) - Machine-Maker
[PaperMC/docs] branch deleted: feat/separate-config-specs
b6babbf Tag configuration divs for docsearch - olijeffers0n
2b8252a Detect hash changes within the configuration co... - olijeffers0n
ee9bc01 Fix Server Side Rendering for the configuration... - olijeffers0n
9c17cd5 Separate config specs into other files (#272) - Machine-Maker
52db768 Merge branch 'main' into feat/add-link-cards - olijeffers0n
A week ago new methods were implemented in the Velocity API module that can help to understand more easily the operation of the Brigadier commands especially for those who are just starting with the Velocity API, by avoiding using generics and adding useful checks to avoid beginner mistakes.
I didn't make this pull request earlier because I was wa...
00958fa Server Start Script Generator - olijeffers0n
[PaperMC/docs] New branch created: feat/add-startup-script-creation
Adds a script generator for starting your server.
bc90bb3 Fix compile - olijeffers0n
I know nothing about the docs, but I would expect that we have some variables for color so that they respect the dark/light theme switch
Yep. Forgot people use light theme. Will address this
a copy to clipboard button would be cool
idk how we do styles for the docs, but having random global tag selectors like this is kinda meh
can't we use scss and nest everything under .server-config-container to prevent leaking of styles?
remove all this inline style (and the 40% in the css) and give .middle-flex-wrapper a gap of 2rem and .config-section flex: 1, that achieves the same look but scales better
why hide overflow here? that removes the scrollbar in the text area, preventing you from viewing all the things
transition: all 0.3s;
cursor: pointer;
a copy to clipboard button would be cool
maybe copy by clicking the script box?
Yeah I think you could get away with putting a copy to clipboard symbol somewhere around there and just making all of it clickable
could lift the replace call out of the ternary to save some chars
nitpick, but I'd uppercase Linux to stay consistent
0051eb3 Added Download Button and addressed Comments - olijeffers0n
This doesn't properly handle the NONE flag type by having 2 empty spaces
There should probably also be some error handling in the file name box so you don't end up nothing there?
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?
[PaperMC/docs] New branch created: feat/update-docusaurus
61ef1b9 Update docusaurus to 3.1.0 for better broken an... - olijeffers0n
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.jaras 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
ea7c587 Address Comments - olijeffers0n
This happens when we have broken links now. Because of the configuration component we have to have it on warn, not throw unfortunately
d16d9c2 Update docusaurus.config.ts - olijeffers0n
a10c675 Apply patch to fix CI on arbitrary anchors - olijeffers0n
08ad3c3 Remove Obsolete Flag - olijeffers0n
Many entries are missing descriptions from the crawler
Can we do something like ['-XX:+UseG1GC', '-XX:+ParallelRefProcEnabled', ..].join(' '), and keep each on their own line?
f6ec936 Improved Velocity command documentation with ne... - 4drian3d
8a841e8 Split Aikar's flags out onto multiple lines for... - olijeffers0n
Yeah, that does increase the readability and makes it easier to modify them in the future ๐
edf8d81 Update docusaurus to 3.1.0 for better broken an... - olijeffers0n
[PaperMC/docs] branch deleted: feat/update-docusaurus
6f494d8 Automate the versioning of doc contents (#212) - olijeffers0n
80b6a1e Add Command to CONTRIBUTING.md - olijeffers0n
b6babbf Tag configuration divs for docsearch - olijeffers0n
2b8252a Detect hash changes within the configuration co... - olijeffers0n
ee9bc01 Fix Server Side Rendering for the configuration... - olijeffers0n
PR Missed when Paper PR was merged. Can't wait to maybe get config docs in Paper repo one day ๐
5c570a9 Add description for command block config values... - Machine-Maker
[PaperMC/docs] branch deleted: feature/command-block-configs
We can yeet the java.time. if we're linking to it
Doesn't exactly fit into the title 'add javadoc stuff'
On the line below the Scheduler name also exists so placing it there would work
6626a1d Document the worlds section of the bukkit.yml - olijeffers0n
[PaperMC/docs] New branch created: feat/document-bukkit-worldgen
e3f1f83 Document a couple of API example scripts - olijeffers0n
[PaperMC/docs] New branch created: feat/add-api-examples
c1ad2ef Add variables to remove confusion - olijeffers0n
33ffe4a Document the worlds section of the bukkit.yml (... - olijeffers0n
[PaperMC/docs] branch deleted: feat/document-bukkit-worldgen
can be merged into the previous jq call (jq -r '.versions[-1]')
English is not my native language, but I think there's a missing comma before as experimental builds:
You should always serve and use stable builds, as experimental builds are prone to errors and do not receive support.
I think the -r (output raw strings, not JSON texts) option can be safely removed here, since the build is an integer
I cannot comment on these, i don't know jq syntax and am on my windows PC without wsl. If someone else could confirm please and thank you ๐ - or if you can test @zlataovce
e2b9524 [ci skip] add tsconfig for proper compilation w... - olijeffers0n
f6ec936 Improved Velocity command documentation with ne... - 4drian3d
edf8d81 Update docusaurus to 3.1.0 for better broken an... - olijeffers0n
5c570a9 Add description for command block config values... - Machine-Maker
33ffe4a Document the worlds section of the bukkit.yml (... - olijeffers0n
I hate how inconsistent the usage of " and ' is in this file, do we have editor config or eslint or prettier or whatever to enforce one? lol
3f35e71 Change double to single quotes - olijeffers0n
Haha, yeah. I've changed this file for now. In the future id like to have some sort of formatting checker and also a British checker for me :P
I think this warning should be higher up
710cbc2 Bump warning and address script comments - olijeffers0n
c03ea77 Fix vercel attribution for hosting - olijeffers0n
[PaperMC/docs] New branch created: fix/vercel-attribution
We probably shouldn't use the hosted version, we should bring the asset into our repository.
[PaperMC/docs] New branch created: vercel
[PaperMC/docs] branch deleted: vercel
3c91ce0 Move image to repo and decrease padding - olijeffers0n
[PaperMC/docs] branch deleted: fix/vercel-attribution
3fcb1a3 Reorder flags - olijeffers0n
[PaperMC/docs] branch deleted: feat/add-startup-script-creation
It should be noted there is a requirement that jq be installed.
fecc8af Update Java Install Instructions (#278) - Ame-chan-angel
ebe600d Recommend Java 21 - olijeffers0n
2ef8151 Fix getting started docs:Requires Java 17, Reco... - olijeffers0n
e2b9524 [ci skip] add tsconfig for proper compilation w... - olijeffers0n
f6ec936 Improved Velocity command documentation with ne... - 4drian3d
75974ff Overview of Plugins - olijeffers0n
[PaperMC/docs] New branch created: feat/restructure-paper-docs
they can be written in other languages that run on the JVM as well, such as Kotlin, Groovy or Scala
duplicate sentence (first occurrence is a line above)
`PlayerMoveEvent` is cancellable. Cancelling it would mean that the
is the plus sign at the end intentional?
In the Repository Restructure Project was also the mention of item meta, as in how to apply item meta to an item.
I could try and work on such a page if that is wanted. Just would need rough guidelines on what it should cover about the Item Meta. I believe the default stuff (name, lore, ...) and the Skull Meta stuff would be a good start?
ItemMeta is deprecated going forward with its replacement being the Item Property API. So hold off writing this page for now but feel free to chat in our discord server in #docs-website or look through the other issues for good things to document! Contributions are always welcome!
e567832 Address Comments - olijeffers0n
5ba34d0 Add Cards to project title pages (#274) - olijeffers0n
41aa580 Document a couple of API example scripts (#284) - olijeffers0n
[PaperMC/docs] branch deleted: feat/add-api-examples
[PaperMC/docs] branch deleted: feat/add-link-cards
oh its been merged while i was reviewing lol
could emphatically confuse people?
could it be simplified to strongly?
Missing end of assignment i think?
jq -r '.versions[-1]')
maybe consider downloading it with a unique name (include version + build number), so it cant be used as-is in start.sh
ea4dedc Add initial docs for Entity Pathfinders and Mob... - olijeffers0n
[PaperMC/docs] New branch created: feat/document-mob-goals
I have not extensively used either of these API's in the past, however these seem to work
344a452 Document Adventure Audiences - olijeffers0n
[PaperMC/docs] New branch created: feat/adventure-audiences
[PaperMC/docs] New branch created: feat/chat-event
Turns out there was already a PR for this :P
:::tip[ChatRenderer.ViewerUnaware]
If your renderer does not need to know about the viewer, you can use the `ChatRenderer.ViewerUnaware` interface instead of the `ChatRenderer` interface.
This will benefit performance as the message will only be rendered once instead of once for each viewer.
:::
Plugins are a way to extend the functionality of a Minecraft server. They are written in JVM-based languages such as
Events are a way for plugins to listen to things that happen in the server.
Events are fired when something happens, and plugins can listen to these events and run code when they are fired.
Plugins can listen to this event and run code when it is fired.
the same thing (roughly) is repeated a few times in one paragraph
to run after 100 ticks - one second is 20 ticks during normal operation. It is important to note that tasks might be delayed if the server is lagging. For example, if
the can be loaded and unloaded at runtime part is mentioned in the lifecycle section, so it's redundant here
[PaperMC/docs] branch deleted: feat/chat-event
f4ef655 Address Comments - olijeffers0n
I think that the styling on some of the links is a bit wonkey, but looks generally good. Thats obviously not your fault
made add something like that all command senders are an audience and that server, world and team are forwarding audiences?
open is a bit ambiguous here as iirc it refers to both villagers opening doors or zombies breaking doors, it basically makes the pathfinder consider wodden doors as open I guess? (didnt check code)
an example would be nice I guess?
I wouldn't call this heading stopping but removing
this needs notes on how vanilla selects which goals to activate and prolly some more caveats on how pathfinding works from somebody who actually uses the pathfinder, iirc it can ge all kinda wonky to call moveTo every tick.
maybe add something about extending javaplugin and a big note about not using the ctor
I would add something about doing some checks first. i.e. in player move event, you often only care if they actually moved to a new block, so check that first and early return
this could be linked to the event api pages for how to register listeners
players, the console, rcon, command blocks etc
this note here is good and I believe it should be added to the scheduler page too
c370a6b Address Comments - olijeffers0n
e39717e Document our enabling of sand duplication - olijeffers0n
[PaperMC/docs] New branch created: feat/doc-sand-duping
this reads weird, if you only listing one, maybe we should just write something like
This setting allows for exploits related to end portal teleportation to be
possible, for example sand duplication. This
I feel like we should note somewhere that unsupported settings might vanish at any time
[PaperMC/docs] branch deleted: feat/restructure-paper-docs
I feel like we should note somewhere that unsupported settings might vanish at any time
Sure, not sure if this is the place though. Might require modifying the Config.tsx to allow a "note" on non-leaf nodes
5abc221 feat: ConfiguredProperty for documenting "magic... - olijeffers0n
Need some input on where to store these values. Also, what other values need documenting.
maybe store it in a separate JSON? Where to store it is a different question. Maybe config dir? a new dir for that seems overkill. Root dir is also a bit meh but easily findable. I'd just say config to be honest.
b53f932 feat: Add warning to unsupported settings - olijeffers0n
[PaperMC/docs] New branch created: feat/warn-unsupported-settings
1c73504 feat: Add warning to unsupported settings (#294) - olijeffers0n
[PaperMC/docs] branch deleted: feat/warn-unsupported-settings
788eece fix: reword how plugins work and move category - olijeffers0n
[PaperMC/docs] New branch created: fix/wording-of-how-plugins-work
8f406cf Add property component to recommendation - olijeffers0n
ad3b7c1 Add info to CONTRIBUTING.md - olijeffers0n
[PaperMC/docs] New branch created: feat/update-docusaurus
Not many notable changes, but I cant deal with the notification in my terminal
2e2320b Update Docusaurus - olijeffers0n
[PaperMC/docs] New branch created: feat/update-docusaurus-3.1.1
[PaperMC/docs] branch deleted: feat/update-docusaurus
Not many notable changes, but I cant deal with the notification in my terminal
worth to note that they should be in the plugin's respective data directory in plugins and not the root
There is a section in https://docs.papermc.io/paper/aikars-flags, that says if you has 12G+ memory, you should adjust flags a little.
Script Generator completely skips that part and just pastes static flags.
I'll change it to an issue about the Aikar's flags themselves, not the generator [based on this](#docs-website message) and leave it for @olijeffers0n to decide.
Thanks for the report nonetheless.
I assume this changes the url? if so, we need a redirect
It does not change the slug
[PaperMC/docs] New branch created: fix/proper-aikars-flags-for-higher-memory
e79a09e fix: Adjust Aikar's flags for high memory - olijeffers0n
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...
Core Team dev [told](#docs-website message) that 12G flags will cause issues in modern java.
But you decided to add them.
I'm confused. ๐ค
Core Team dev [told](#docs-website message) that 12G flags will cause issues in modern java. But you decided to add them. I'm confused. ๐ค
We're on it already, there was a misunderstanding here.
[PaperMC/docs] New branch created: cleanup-aikars-flags
Seems to me the page about Aikar's flags is a bit dated.
Cleaning it up a little and making it a consistent page,
also closes #298 and #299.
[PaperMC/docs] branch deleted: fix/proper-aikars-flags-for-higher-memory
Think on the getting started page or something we provide an example using 2G. Can you bump this to 4G as I believe this is the amount we recommend as a realistic value
8ae4207 cleanup getting started and promote the script ... - Nacioszeczek
457968f Cleanup Aikar's flags and Getting Started (#300) - Nacioszeczek
[PaperMC/docs] branch deleted: cleanup-aikars-flags
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...
Is it possible to disable the GUI option by default when Server Configuration uses Velocity Flags?
Yeah this flag shouldn't be added when Velocity is selected as Velocity will not start then
cc @olijeffers0n
e92b933 Re-add full stop - olijeffers0n
[PaperMC/docs] branch deleted: feat/update-docusaurus-3.1.1
c36be75 fix: Change Padding around icons - olijeffers0n
1c73504 feat: Add warning to unsupported settings (#294) - olijeffers0n
457968f Cleanup Aikar's flags and Getting Started (#300) - Nacioszeczek
1bcca2a Update StartScriptGenerator to not use gui when... - olijeffers0n
72a53aa fix: admonition title cannot be code - olijeffers0n
Thank you, I have used your comment
5480ee8 Address Comments - olijeffers0n
b483e38 Add Spellcheck Action - olijeffers0n
[PaperMC/docs] New branch created: feat/basic-grammar-checker
d343a67 Remove British to pass CI - olijeffers0n
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.
[PaperMC/docs] branch deleted: feat/basic-grammar-checker
Does this need to be GitHub.repository.full_name to check the name string, not the object itself?
Could it be moved into the .GitHub directory to avoid clutter, or can it be used "by default" by running the program locally
Can it be ignored per-file instead? Incase someone else types it not refering to the option?
It's quite a narrow case tho
github.repository is already a string and it's used like that in the Paper repo, so should be fine
Recognising / recognised?
Regionised, regionise?
Ah ok, it's not like the webhook event obj
the CLI searches for it by default, so yes, it would be used if someone just locally ran typos in the directory without options
I'm afraid not, there'd have to be a separate config
ooops, wanted to do a PR, oh well
I like and it already caught some typos (even ignoring the bri'sh spellings)
9f5ab67 fix: Reword how plugins work and move category ... - olijeffers0n
[PaperMC/docs] branch deleted: fix/wording-of-how-plugins-work
0b0edc1 Initial Work on Lifecycle API - olijeffers0n
[PaperMC/docs] New branch created: feat/lifecycle-api
not that familiar with React components, but couldn't this also be typed?
export default function ConfiguredProperty({ propertyKey }: { propertyKey: string }): string | null {
export function getConfiguredProperty(propertyKey: string): string | undefined {
this name seems a bit iffy, maybe something like hasConfiguredProperty?
[PaperMC/docs] branch deleted: feat/api-roadmap
6d6d5ee feat: Property for documenting "magic" values c... - olijeffers0n
[PaperMC/docs] branch deleted: feat/property-api
10b9a63 fix: Don't duplicate titles in Velocity Docs - olijeffers0n
export default function ConfigurationStructureDiagram() {
the colon looks a bit off in the TOC
I have no clue if this is needed but it makes it clear what means.
{ name: "paper-world.yml", type: "file", url: "/paper/reference/configuration#per-world-values", description: "Every world folder will have this file." },
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...
fixes #308
@phant0m2290 if you want me to add you as co-author i would need your commit signature
fixes #308
@phant0m2290 if you want me to add you as co-author i would need your commit signature
how do i do that?
fixes #308
@phant0m2290 if you want me to add you as co-author i would need your commit signature
how do i do that? or what is that? @Leguan16
The email and user you provide to commit something to a git repo.
fixes #308
@phant0m2290 if you want me to add you as co-author i would need your commit signature
how do i do that? or what is that? @Leguan16
The email and user you provide to commit something to a git repo.
Ahh alr
user: phant0m2290
email: titulaerkay@gmail.com
done.
fixes #308
@phant0m2290 if you want me to add you as co-author i would need your commit signature
how do i do that? or what is that? @Leguan16
The email and user you provide to commit something to a git repo.
Ahh alr user: phant0m2290 email: titulaerkay@gmail.com
done
a1beb7c Add some notranslate hints - electronicboy
[PaperMC/docs] New branch created: ench/translation-hint
I have no sane means to test this, but, this should tell site translators to not translate certain aspects of the configuration, if we want to go on with this, there's probably several other things we'd want to apply this to, i.e. any cross-refs to the configuration page, for ex
To add modern forwarding support to Forge, you must install the [ProxyCompatibleForge](https://modrinth.com/mod/proxy-compatible-forge)
Not sure whether breaking away from strictly US English is desirable, but I think it makes sense to use the British spelling here to stay consistent with the Bukkit (Paper) API.
4c83725 style(typos): spell check variants of `cancella... - zlataovce
See CI Fail, we are going with British spelling of cancelling to be consistent with Bukkit
do we really need to copy in the whole theme when we (at least from a quick glance) only modify one file?
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
953f47a Document our enabling of sand duplication (#292) - olijeffers0n
Sunsetted is past tense and past participle. Sunsetted is also only grammatically correct when it is a noun or adjective. In this case, the word โsunsetโ is acting as a verb, meaning it doesnโt need โ-edโ. Therefore, โsunsettedโ is incorrect and โsunsetโ needs to be used here.
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...
"customer" ๐
What else do you want to call it? ๐
Has this CSS been validated for light mode? It appears this way on Firefox and Chromium based browsers.
[PaperMC/docs] branch deleted: feat/doc-sand-duping
eolMessage: We recommend you transition to [Velocity](https://papermc.io/software/velocity). For more information, see the [announcement](https://forums.papermc.io/threads/1088/).
eolMessage: We recommend you transition to [Velocity](https://papermc.io/software/velocity). For more information, see the [announcement](https://forums.papermc.io/threads/1088/).
const eolMessage = "This project has reached end of life and is no longer maintained. " + props.content?.frontMatter?.eolMessage || "";
If you run the format script through yarn right now, you'll find yourself with a whole bunch of changes, even breaking documentation in some places; this PR aims to fix that.
Seems like Prettier does not support MDX v2 nor v3 yet, so I chose to ignore all Markdown and MDX files for the time being.
Not sure why we are including node_modules?
Prettier automatically looks inside .gitignore, so it's redundant to ignore it there as well
function name seems a little odd, considering it's not a page
function EOLMessage(message: string): JSX.Element {
eolMessage should probably be renamed to eol_message to stay consistent with other front matter properties
there could be an explicit line break before the message, I think it looks a little better:
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
Some things that came into my mind:
- Whitelist
- Optimisation
- Maybe some thing about permissions?
- how to add plugins
- mention port forwarding and maybe ref to another external site
- useful commands
[PaperMC/docs] New branch created: feat/admin-landing-page
ba867c2 Administration Landing Page for after server setup - olijeffers0n
Closes #318 - Adds a landing page that can be linked to for after the server has actually been started
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...
optimisation/optimise/optimised is British English; should probably be added to the spell checker
dbb2ee1 Administration Landing Page for after server se... - olijeffers0n
[PaperMC/docs] branch deleted: feat/admin-landing-page
{ name: "permissions.yml", type: "file", description: "This file allows creating of permission nodes so that server admins can easily distribute permissions." },
{ name: "ops.json", type: "file", description: "This file stores a list of all players with operator status." },
Or something like this
Should version_history.json also be on here?
703e749 feat: Rework navigating configuration pages (#236) - olijeffers0n
0d66c74 fix: Rename Site title to fix text wrapping issues - olijeffers0n
Also fixed some weird markup in the contributing file and included it in Prettier's check along with the readme.
The PDC API recently was expanded to cover list types. This commit adds a simple example for developer that either
a) Want to store a list of a custom pdt
b) Want to store a list of strings or other api defined types
The commit also provides a quick example of retrieving the data as the implementation allows fully type-safe access to the data.
Also drops some unneeded spaces at EOL.
Is it worth listing the inbuild ones? I know you can see them from the javadocs so Iโm not sure here.
That's a lot to list and kinda just mirrors the existing list. I wouldn't add it but if others think that is benefitial, sure
The ip logging option was implemented by mojang in 1.20.2 and replaced the existing paper configuration option.
This commit properly moves the documentation and name of that option.
Improved Migration From CraftBukkit or Spigot by adding another step
Improved Migration From Vanilla by adding another step
The step that I added to both tutorials:
Rename the downloaded file to match the name specified in the start command
Not properly read this, noticed from a skim
3. Rename the downloaded file to match the name specified in the [start command](../getting-started/getting-started.mdx#running-the-server).
3. Rename the downloaded file to match the name specified in the [start command](../getting-started/getting-started.mdx#running-the-server).
3. Rename the downloaded file to match the name specified in the [start command](getting-started.mdx#running-the-server).
3. Rename the downloaded file to match the name specified in the [start command](getting-started.mdx#running-the-server).
Thanks to @zlataovce and @olijeffers0n for suggesting changes
- Added one more step to updating Paper Tutorial.
- Formatted logs in AddingPlugins > Troubleshooting to resemble console output.
- Added a tip for the backup step of the Paper Update tutorial
The step that I added

The tip that I added

How the logs look after the change

a59285d Updated SnakeYAML Author and Links (#315) - ilgrandeanonimo
953f47a Document our enabling of sand duplication (#292) - olijeffers0n
8110eb2 style: fix Prettier configuration and reformat ... - zlataovce
af0fe0b fix: hotfix the typos action - olijeffers0n
dbb2ee1 Administration Landing Page for after server se... - olijeffers0n
kinda a one stop shop kinda deal with an intro on why stuff is different (history of cb/spigot, why do we fix exploits, tradeoffs for performance), some example of what is different and a list of all config options (with links to the config page) we suggest tweaking to get closer to vanilla again
this could also be handled via way to install paper via a preset (which would be a new paper feature that needs to be discussed)
What do you mean with "preset"? You mean that you can define plugins, config etc. which will automatically apply on first server start?
yes, altho we are not sure that is a good idea (we wouldnt recommend plugins, just config) and a good doc page will get us a to help 80% of people anyways
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...
In Line 173. That should also be Bukkit not Paper.
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...
[PaperMC/docs] Pull request opened: #327 Added BungeeForge note to Velocity server-compatibility.mdx
Specifically under the Minecraft Forge (1.7.2-1.12.2) section, BungeeForge can be used in situations where SpongeForge isn't supported, compatible, or if the server admin feels their server doesn't need SpongeForge.
BungeeForge is a very small project which appears to be abandoned for about 3 months, Iโm hesitant to recommend it. Can you shed some light on why you are making this PR - has it helped you before?
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...
[PaperMC/docs] New comment on issue #21: Add page documenting gameplay changes and how to reset them
I made a list of differences, along with the changed config files:
https://gist.github.com/Earthcomputer/2296da33b8cc91dba81b48103c0e1fe3
[PaperMC/docs] New comment on issue #21: Add page documenting gameplay changes and how to reset them
I made a list of differences, along with the changed config files:
https://gist.github.com/Earthcomputer/2296da33b8cc91dba81b48103c0e1fe3
Incredible thank you. I will modify my PR the upcoming days.
MINECRAFT_VERSION="1.20.4" is surely a copy/paste oversight, we need to obtain the build of the LATEST_VERSION and not of the MINECRAFT_VERSION, in the next steps we are rightfully referring only to the LATEST_VERSION.
in my opinion, it should rather use MINECRAFT_VERSION to match the example's description and the latest version query should be extracted into another example
According to https://plugins.gradle.org/plugin/io.papermc.paperweight.userdev, the latest version is now 1.5.12
This PR is supposed to update that
2ffab79 Conditionally apply EOL tags - electronicboy
[PaperMC/docs] New branch created: fix/deprecation-links
There may be a better way to do this (Still new to TSX), I recall using some library elsewhere for this, but, probably not worth adding, etc
c963619 fix: Conditionally apply EOL tags (#330) - electronicboy
[PaperMC/docs] branch deleted: fix/deprecation-links
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.
- A
// TODO: dynamic classcomment has been added next to the leftover complex inline styles. - Inline styles calling the margin[...] properties have been updated to use Docusaurus' margin-[...]--sm and margin-[...]--md classes for consistent margin sizes.
- Inline styles have been merged...
considering INDENT_SIZE is a constant, this can be safely extracted into a conditional class
any particular reason all these have been split? cant have have them all in one string and only hte active one in another? or at least group stuff that belongs together, like config-node with-value and clean-btn button--link, no need to have this use to many lines
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! ๐
b4e1eee fix: Use the proper Link component for relative... - granny
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.
A dropdown-item-selected class has also been added to this PR
The internal styles added to the slider markers has been replaced with flexbox styling. It's now more accurate than how it was before.
Any leftover internal styling and TODOs have now been removed.
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.
As a suggestion/question, would it make sense to put the pause statement behind a toggle that by default is turned on?
i didn't look into the component too much but as it looks to me that would require moving stuff around a lot so we can have different toggles for windows and linux. since i am very sure 90+% windows folks are gonna double click it i don't see much reason to have a toggle here.
I guess that's fair. I don't use the script generator anyway, and also didn't expect that much more work for a toggle so you have my approval (not that you need it, anyway)
if (platform === "linux") {
content = "#!/bin/bash\n\n" + content;
} else {
content = "@echo off\n\n" + content;
}
I would rather do this like this, or with a ternary. Up to you :)
i know this is technically completely out of scope for this pr (but opening a pr for this small thing is eeh) but shouldn't we have the gen add "nogui" instead of "--nogui" that way it will also work on older versions
typos 1.20.1 has been released with a fix for the underlying false positive, so the manual ignore isn't needed anymore
so the manual ignore isn't needed anymore
Done ๐
77a81ed Document our tripwire dupe - olijeffers0n
[PaperMC/docs] New branch created: feat/document-tripwire-changes
[PaperMC/docs] New branch created: feat/docusaurus-3.2.0
Mostly Performance Increases. See changelog here:
https://docusaurus.io/blog/releases/3.2
4290837 Update Wording - olijeffers0n
39b68fb feat: Document our tripwire dupe configuration ... - olijeffers0n
[PaperMC/docs] branch deleted: feat/document-tripwire-changes
i know this is technically completely out of scope for this pr (but opening a pr for this small thing is eeh) but shouldn't we have the gen add "nogui" instead of "--nogui" that way it doesn't crash on older versions
Yes, we should. Feel free to add that to this PR if you would like, and I will rename the commit on merge
First is the PR, Second is Prod. The Config Pages have changed slightly with respect to margins and highlight colours not being active.
I would like to thank you for explaining your reasoning here, and we are happy for you to recommend this within the community, however, we do not feel comfortable merging this into our documentation at this time. Thank you for your contribution!
shouldnt this new option also be added to the config reference?
Add a documentation about all vanilla commands and their respective permissions. A not whether they are given by default or need extra privileges (eg. op) would also be nice.
Reference: outdated wiki page
854e223 fix: Improve Start Script Generation for Window... - notTamion
f5668d2 feat: Update Docusaurus to 3.2.0 (#339) - olijeffers0n
[PaperMC/docs] branch deleted: feat/docusaurus-3.2.0
Yeah for sure! Thanks for considering it!
- Selected config options should now properly highlight like before.
- The margin indenting being off is technically on purpose since docusaurus' built-in
margin-bottom--smclass is not 10px, but something closer to 8px. Withmargin-bottom--xsbeing closer to 4px andmargin-bottom--mdbeing closer to 16px.
Looks generally good, Iโll review properly soon
Frequently see questions in Discord about javadoc not showing up, add some examples how to download the javadoc in maven/gradle & intellij etc
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 ;)
704d5bd chore: remove inline styling & use clsx consist... - granny
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.
b3e0b9f fix: rearrange dir structure and naming of comp... - olijeffers0n
[PaperMC/docs] New branch created: feat/quick-rearranging-of-components
Shouldn't this be your plugin? like it was before
This should stay Boolean no? Since the type is Boolean
This should probably mention Configurate 4 now? Since velocity 3.3.x Configurate 4 is bundled
it's a top-level heading, which were all made Upper Case
the version could probably be removed altogether
player.sendMessage(text("I stopped following you!"));
If we want to access the current path for the cow, we can call `getCurrentPath()` on the pathfinder:
I'm not too sure about the lower headings being lower case, need more opinions here
Welcome to the Folia administration guide! This guide includes information and tutorials
- Alter the transparency of any elements within the PaperMC logomark.
it is spelled with a space on other pages, so I presume those should be switched too?
Yes please, looking at the Minecraft Wiki this is how it should be spelt
9d21523 fix: rearrange dir structure and naming of comp... - olijeffers0n
[PaperMC/docs] branch deleted: feat/quick-rearranging-of-components
since PersistentDataType is a class reference, I wanted to put it in backticks, however that resulted in it being snapped out of the admonition title into a separate element (you definitely can use backticks in those though, so I'm not sure what's the problem) - that's why I ended up removing it entirely
[PaperMC/docs] New branch created: feat/update-docusaurus
i got forced to approve this
8c157bc Initial Separation Of projects - olijeffers0n
[PaperMC/docs] New branch created: feat/seperate-navbars
14e413a Sidebars are separate for sub-items - olijeffers0n
TODO:
- [ ] turn
src/util/gitUtils.tsinto a yarn patch- split the shell execution out into it's own method to make it easier to recreate
getFileCommitHash
- split the shell execution out into it's own method to make it easier to recreate
- [ ] move
parseFrontMatterfunction elsewhere? - [ ] better naming for
LastCommitIncomponent and it's translation key/values
[PaperMC/docs] branch deleted: feat/update-docusaurus
TODO:
Write info for these commands:
/paper fixlight
/paper mobcaps
/paper playermobcaps
The heap dump contains detailed information about your server, which can be sensitive.
Needs a better description
Use the vanilla resource pack and font.
Link to the docs page about this system property
Dumps info about the item that the player is holding. Can only be used by players!
Is this the first call? If so a simple boolean check would suffice here
What's going on here? Is there transitively 2 versions of utils?
I don't like this, should be a bit longer
### `/paper mobcaps`
Permission: `bukkit.command.paper.mobcaps` <br>
Usage: `/paper mobcaps [world]`
This command provides about the world specified within `[world]`. This includes ...
Using a format like this for all subsequent subcommand would be good thank you
416d78b chore: syntax cleanup and standardization (#343) - zlataovce
- Alter the transparency of any element within the PaperMC logomark.
Shouldn't elements be singular here?
Look at other md files. They all have at least a slug and a description.
should be capitalize as in the above diff (+ added to spell check :smile:)
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.
- Switched to
@docusaurus/plugin-vercel-analyticsfrom@gracefullight/docusaurus-plugin-vercel-analytics. - Bumped
@types/nodeand the devcontainer's Node version to 20. - Switched to
corepackfor managing ayarndistribution. - Bumped assorted dependencies, matching their versions with ones inherited from Docusaurus.
- Fixed an unmet peer dependency warning.
ref: https://github.com/PaperMC/docs/pull/343/files#r1561017974
idk if this is a fix or chore im new to this schema xd
This description isn't sufficient to describe all the functionality this affects. It affects more than just treasure maps or ender eye items, it affects any logic that searches for structures in the world, like the /locate command or plugins doing structure searches.
Considering that Paper plugins are the new hotness, we should probably distinguish the old Bukkit plugin YMLs from the new paper-plugin.yml, especially considering that a plain 'Plugin YML' page on the 'Paper' site lends itself to assuming 'Paper Plugin YML' is what the page describes, despite that being not the case.
For starters, the sidebar tree feels a bit too deeply nested; as a "quick fix" I'd probably make Administration/Development/Contributing their own toplevels and lift their children up to the top of the sidebar.
Some of the categorization would be better suited as inline headers in the sidebar instead of another level of nesting.
artist rendition of a straightforward but fruitful improvmeent to the sidebar structure
description: Vanilla Minecraft commands and their associated permissions.
The following is a list of permissions for Vanilla commands.
should probably be moved into a different directory, there's no component in the file
the category pages feel a bit Unstructured as just a plain but large list of their contents; they could have a similar treatment to the sidebar and have inline headers
artist rendition of improvement:
Have you taken a look at https://github.com/PaperMC/docs/pull/346 yet? Most recent change on that PR is deployed here
cool, that's how i would start untangling the site's structure
[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...
835254e feat: add item converter tool, link to minimess... - MiniDigger
[PaperMC/docs] New branch created: tools
description: A tool to update commands from the old NBT-based item format to item components.
the front matter title could exclude the heading's parentheses, looks a little nicer on the sidebar
title: MiniMessage Web Editor
description: A web-based editor for creating and previewing MiniMessage-formatted text.
Maybe move the tools section all the way down to the bottom?
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
the README.mdx files are needed to not void existing links; they need to be kept or a redirect needs to be set up
Maybe move the tools section all the way down to the bottom?
It is standard for us to put categories at the top
I'm not sure this is true - could you clarify?
In addition to the Doc Cards being weird on main admin/dev/contrib pages, I find it weird that the "Welcome to the paper docs" at the top of sidebars have a doc icon as well. Overall, I am a fan of the style though! thanks
Check Vercel Comments Please
Just to make sure this isn't merged early: Needs to wait on more backend changes + it should get a dropdown for switching from the default Command to Item argument and Component argument with their different endpoints
In addition to the Doc Cards being weird on main admin/dev/contrib pages, I find it weird that the "Welcome to the paper docs" at the top of sidebars have a doc icon as well. Overall, I am a fan of the style though! thanks
fixed this
the vercel comments aren't public
The button effect fadeout looks a bit weird with the text briefly becoming gray and then white again. The boxes should also be a bit larger since the main use here is for longer commands
Should specify exactly 1.20.4. Afaik, the convert is only converting from 1.20.4 to 1.20.5, not < 1.20.5 to 1.20.5
the vercel comments aren't public
Some table cells need restyling to avoid wrap
For now, I added the 2 new server.properties entries and plugin.yml now accepts patches in their api-version field. Let me know if i missed something.
Blocked until 1.20.5 ready.
description: "Whether this server accepts transfers from other servers using the transfer command/packet. If this is set to false, the server will disconnect the client."
If set to "none", region files will take up significantly more disk space, but might make sense together with filesystem-level compression.
would this make more sense?
If set to "none", region files will take up significantly more disk space, but it might make sense together with filesystem-level compression.
[PaperMC/docs] New branch created: ver/1-20-5
[PaperMC/docs] branch deleted: ver/1-20-5
[PaperMC/docs] New branch created: ver/1-20-5
fbd4792 Document various 1.20.5 config changes (#361) - Leguan16
a564933 Update toolchain version to Java 21 in Paper pr... - NoahvdAa
[PaperMC/docs] New branch created: update-java-toolchain-version
In the future, we should allow for properties in code blocks, however this works for now. Thanks
a6a1841 chore: Update toolchain version to Java 21 in P... - NoahvdAa
[PaperMC/docs] branch deleted: update-java-toolchain-version
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
- It is moj mapped anyway and
- If i add this line, it prints me an error that it could not resolve the
MOJANG_PRODUCTIONproperty - It doesn't make sense to add this as userdev would set i...
I seem to understand it now. I was using groovy and not kotlin dls. Thats why it didn't work. I got it working and it seems to be clear now whats going on :)
```kotlin title="build.gradle.kts"
Additionally, you need to remove all `dependsOn(reobfJar)` lines.
all build scripts in the docs are afaik Kotlin DSL, so specifying the Groovy variant is unnecessary
```kotlin title="build.gradle.kts"
ships with, same in the other two places
This should also mention setting the attribute automatically via userdev
You may still set the spigot namespace to get remapped
I just took jmp's message as reference. Will change it. Thank you for the feedback.
You only have to change this setting if you are using Bukkit/Spigot plugins. Paper plugins are already assumed to be Mojang-mapped.
If you are using Paper plugins, but want to explicitly use Spigot mappings, you need to change the property to:
To tell the server that your plugin is Mojang-mapped, you need to add the following code to your build script:
If you are using Spigot/Bukkit plugins, your plugin will automatically be remapped to Spigot mappings.
remapped to Spigot? aren't they getting remapped from spigot to mojang?
should be explained a bit more. link to the other page? link to announcement?
most people also definitely have no clue what commodore is, and if they try to find out they'll likely find https://github.com/lucko/commodore. needs to be explained.
every time it is loaded for the first time.
This doesn't make sense. every time or just the first time?
I'm not sure the since 1.17 part is relevant. userdev users don't need to know or care about Paper's internal development process. Might add more confusion without any real benefit.
Maybe "on change" or something would be better.
I will think of something better. If someone has a suggestion please let me know.