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

Implement Initial Setup System for Missing Configuration Files #19

Open
AzaleeX opened this issue Aug 20, 2024 · 0 comments
Open

Implement Initial Setup System for Missing Configuration Files #19

AzaleeX opened this issue Aug 20, 2024 · 0 comments
Assignees
Labels
Category: UI Issues related to the user interface of the software. Priority: Low Low-priority issues that can be addressed later. Status: confirmed Issues that have been verified and confirmed by the team. Type: Todo Tasks that need to be completed.

Comments

@AzaleeX
Copy link
Member

AzaleeX commented Aug 20, 2024

Summary

It is proposed to implement a guided setup system that runs when the server starts and detects that the configuration files (such as server.properties) are missing. This setup process would interactively ask the user a series of questions to generate the necessary configuration, ensuring the server is correctly set up without requiring manual editing of configuration files.

Details

Proposed Setup Flow

  1. Language Selection:

    • Prompt the user to choose a language for the server (e.g., English, French, etc.).
    • The selected language would be used for all subsequent prompts and server messages.
  2. Server Configuration:

    • The setup would ask the following questions to configure the server:
      • MOTD: What should the server's (MOTD) be?
      • SUB_MOTD: Any additional subtitle or sub-MOTD?
      • SERVER_PORT: Which port should the server run on? (Default: 19132)
      • SERVER_IP: What IP address should the server bind to? (Default: 0.0.0.0)
      • WHITELIST: Enable whitelist? (Options: on / off)
      • MAX_PLAYERS: Maximum number of players allowed on the server?
      • GAMEMODE: Default game mode for players? (Options: Survival, Creative, etc.)
      • PVP: Enable player versus player combat? (Options: on / off)
      • DIFFICULTY: Set the difficulty level? (Options: Peaceful, Easy, Normal, Hard)
      • LEVEL_NAME: What should the world name be?
      • LEVEL_SEED: Provide a seed for the world generation (optional).
      • LEVEL_TYPE: Specify the world type (e.g., DEFAULT, FLAT, etc.).
      • AUTO_SAVE: Enable automatic world saving? (Options: on / off)
      • XBOX_AUTH: Should Xbox Live authentication be required for players? (Options: on / off)
  3. Skip or Continue:

    • At any point, allow the user to skip the detailed setup and proceed with default values.
    • Provide an option to review and confirm the settings before finalizing the configuration.

Benefits

  • User-Friendly: Simplifies the setup process, especially for new users who may not be familiar with manual configuration.
  • Consistency: Ensures that all necessary configuration values are set up correctly, reducing the likelihood of errors.
  • Flexibility: Users who want more control can customize their server during setup, while those who prefer defaults can quickly skip through.

Additional Considerations

  • Provide a command to rerun the setup if the user wants to change their configuration later.
  • Ensure the setup process is compatible with both GUI and console environments.
  • Save the configuration in a structured way to allow easy future modifications.

Impact

Implementing this feature would enhance the usability of the server software, particularly for less experienced users, by providing a straightforward way to set up their server with minimal hassle.

@AzaleeX AzaleeX added Priority: Low Low-priority issues that can be addressed later. Status: confirmed Issues that have been verified and confirmed by the team. Type: Todo Tasks that need to be completed. Category: UI Issues related to the user interface of the software. labels Aug 20, 2024
@AzaleeX AzaleeX self-assigned this Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: UI Issues related to the user interface of the software. Priority: Low Low-priority issues that can be addressed later. Status: confirmed Issues that have been verified and confirmed by the team. Type: Todo Tasks that need to be completed.
Projects
None yet
Development

No branches or pull requests

1 participant