Add PAPER_CONFIG_REPO as alias for defaults repo variable #3076
Conversation
|
@itzg I added two new optional environment variables if you want to set the new config files or if you have a repo to place the files yourself; let me know if you think it is a good idea or if you prefer to make any changes. I am open to new comments. |
There was a problem hiding this comment.
I appreciate what you're trying to enhance; however, it's not what I had intended for the config defaults feature. It was only meant to apply the official default files from PaperMC so that patching could be performed reliably, even with a blank system.
I would prefer you add the example with a patch file that applies the optimizations that you referenced.
|
@itzg I can make that change. Also, can I add my repository in the example docs?? In any case, give me until the end of the day to change the PR and give me to this final day. |
|
No rush at all. Yes, providing the links to your repo and supporting article make sense to include within the example directory/compose file. |
Co-authored-by: Geoff Bourne <itzgeoff@gmail.com>
|
I tested this change with both variables and works. I tried to use the "patching existing files" option, but making some strong modifications is tough. I can't delete some variables and set some maps. 🤔 I don't know if this change convinced you to change the config files with another kind of properties. |
|
Thanks for confirming the change. That's understandable since the patching can already be a little tedious. In that case, the example you have included with the aliased variable of PAPER_CONFIG_REPO seems good as it is. |
| # Repository Proposal for Optimized Minecraft Configurations for Paper | ||
|
|
||
| This repository provides a set of optimized configuration files for Minecraft servers, focusing on improving performance and reducing lag. These configurations are based on community best practices and have been tested. You can also use your config file; you just need to replace the env var with another repo. It's important to follow the structure of a config file version like this [repo](https://github.com/Alpha018/paper-config-optimized). |
There was a problem hiding this comment.
In the context of the examples directory, this paragraph is confusing since it refers to "this repo" which is actually the repo you're maintaining.
Perhaps rather than copy over the README.md as is you could include a comment in the compose file that points users to your repo.
| TYPE: "PAPER" | ||
| VIEW_DISTANCE: 10 | ||
| MEMORY: 2G | ||
| PAPER_CONFIG_REPO: "https://raw.githubusercontent.com/Alpha018/paper-config-optimized/main" # <--- You can use this repo to get paper config-optimized files |
There was a problem hiding this comment.
...could just point users to your repo here
|
@itzg I try to improve the information for better clarity. 😄 |
itzg
changed the title
Hello, I propose setting the paper config files with an env var. To create an optimized config, I made a new repo in this link. Follow the doc of this other link and this discord server. If you want to add more files to the repo with optimization files, please feel free to make a PR.