Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Config cleanup #306

Open
Sh-wayz opened this issue Mar 17, 2021 · 3 comments
Open

Config cleanup #306

Sh-wayz opened this issue Mar 17, 2021 · 3 comments
Labels
Enhancement New feature, request, or thing Good First Issue Good for newcomers

Comments

@Sh-wayz
Copy link
Member

Sh-wayz commented Mar 17, 2021

Feature

  • Config should be sorted by category(rcon, query, world, etc)->alphabetically, with comments describing each section. Comment can be achieved with ruamel.yaml

Reason

  • The config should be mainly self-explanatory to new users. This also stops noob devs like me from spamming petus for help quite as often.
@Sh-wayz Sh-wayz added Enhancement New feature, request, or thing Good First Issue Good for newcomers labels Mar 17, 2021
@BodilessSleeper
Copy link

I'd like to help out but I'm not too familiar with creating servers or Minecraft, and this is what I think how categories should look:

  • server/rcon:
    -- debug
    -- level_name
    -- server_ip
    -- server_port
    -- gamemode
    -- max_players
    -- pvp
    -- hardcore
    -- motd
    -- online_mode
    -- white_list
    -- spawn_protection
  • world
    -- generator
    -- spawn_npcs
    -- spawn_monsters
    -- spawn_animals
    -- seed
  • player
    -- view_distance
  • query
    -- enable_query
    -- query_port
    -- prompt
  • other
    -- vi_mode
    -- comp_thresh

Pls correct me if I'm wrong (which I probably am)
I'd also suggest changing the location of configs (and addition of a default .yaml file) to at least be in the same directory as main if not in the same directory as the startserver scripts, so that users don't have to dig for it (this requires a change in config.py though, to go one or two directories up which can be solved using something like this https://stackoverflow.com/questions/4381569/python-os-module-open-file-above-current-directory-with-relative-path)

@456dev
Copy link
Contributor

456dev commented Apr 8, 2021

additonally i think that it should parse arguments for the location etc
image
like the java equivilant does

@Iapetus-11
Copy link
Member

Iapetus-11 commented Apr 8, 2021

There's a couple issues with this, the PyYAML package doesn't support having ordered dictionary entries, and the server.yml is already in the parent directory?
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature, request, or thing Good First Issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants