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

Added configuration documentation #19

Merged
merged 4 commits into from Nov 22, 2015
Merged

Added configuration documentation #19

merged 4 commits into from Nov 22, 2015

Conversation

SafwatHalaby
Copy link
Member

I added some really needed documentation.
I also made a structural change. It is explained below.

The 4 - plugins section was moved into 2 - configuration basics. The rationale behind this is that now, everything config-related a beginner needs can be found in configuration basics, Namely: Overview of config, setting up WebAdmin, setting up worlds, setting up plugins.

The idea is that everything is now explained briefly in 2 - configuration basics and some stuff would have their own in-depth sections. In the future, we can have a plugins section explaining plugins in detail, and a settings.ini section explaining that file in detail, just like 3 - Configuring world.ini,

@SafwatHalaby
Copy link
Member Author

Also, I removed the "configuration format" file.

  1. It was empty. 2. It's not really needed since the config format is rather intuitive.



<p>
In the example above, you can login to the web admin using the username <code>john</code> and the password <code>cuberiteRocks</code> by pointing your browser to <code>http://localhost:8080</code>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Localhost should probably be the IP of the server. I think there's a section for finding that.

@bearbin
Copy link
Member

bearbin commented Nov 22, 2015

Thanks for this. Looks good apart from the one thing.

@SafwatHalaby
Copy link
Member Author

Done. Shall I squash?


<p>
After downloading a plugin, you need to put it in the <code>plugins/</code> directory.
You should then edit the `plugins` sections of the `settings.ini` file and add a plugin entry there.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown alert :P

bearbin added a commit that referenced this pull request Nov 22, 2015
Added configuration documentation
@bearbin bearbin merged commit ab4a0b2 into cuberite:master Nov 22, 2015
@bearbin
Copy link
Member

bearbin commented Nov 22, 2015

Thanks!

@SafwatHalaby
Copy link
Member Author

I was still pushing changes :P

@SafwatHalaby
Copy link
Member Author

Np, stay tuned for a minor PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants