Skip to content

[FEATURE] Add Server Property Descriptions #355

Description

@bwathen

IMPORTANT: Before Submitting

  • Please search existing issues to ensure a similar feature request hasn't already been submitted or discussed.
    • If a similar feature has been requested, please add your thoughts or upvote that existing issue.
  • Consider if this feature aligns with the general purpose and scope of Bedrock Server Manager.
    • Consider opening a discussion first if you're unsure.
  • Do not remove any sections from this template. Incomplete reports may be closed, delayed or may require more information.

(REQUIRED) Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is.
Example: "I'm always frustrated when [...]" or "It would be helpful if I could [...] because currently I have to [...]"

 # As Minecraft adds more server properties and generally as "casual" Minecraft server manager, I would like to understand the properties available for servers more immediately within the BSM web-app (and maybe in the CLI too, I haven't personally used it).

(REQUIRED) Describe the solution you'd like

A clear and concise description of what you want to happen.
If you have a specific implementation in mind, feel free to describe it. If not, focus on the desired outcome.

 # Place the commented descriptions for each server property from the `server.properties` file as subtext/helper text under each properties input on the `/app/server-properties` page. For example, `max-players` would display the following underneath its number input:

# The maximum number of players that can play on the server.
# Allowed values: Any positive integer

(OPTIONAL) Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.
Why is your proposed solution better than these alternatives, or what are the trade-offs?

 # Maybe to conserve the current vertical "real-estate" on the web app, the descriptions could show on hover as popovers/title attributes on the inputs.

(OPTIONAL) Additional context

Add any other context, mockups, or screenshots about the feature request here.
For example, how would this feature benefit other users? Are there similar features in other tools you admire?

 # I think this could reduce the learning curve for new users of BSM! Love the app so far :)

# I also think it could be helpful to add descriptions similarly to other project-controlled inputs like "autostart" or "autoupdate" (although these are arguable very intuitive). Even a small description of what they control would be a big improvement to the UX!
Image

(OPTIONAL) Use Cases

Please provide one or more specific use cases where this feature would be beneficial.

1.  **Complete Newcomer to BSM/Minecraft server management**
    *   I want to make educated decisions about each property of my server without having to do external research.
2. **A new server property has been added to Minecraft**
    *   As a server manager of any level of experience, I would like to understand new server properties that Mojang has added without needing to do external research.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featNew features or enhancements

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions